Как правильно задокументировать свойство массива в классе для phpdocumentor?

Question

Я пытаюсь выяснить, как правильно задокументировать свойство массива в классе для phpdocumentor.

Пример:

<?php
class foo {
   /**
    * This holds something important
    * @var string
    */
    protected $junk;
   /**
    * This holds an important array of strings
    * @var ???????
    */
    protected $stuff = array();
    // ...
}
?>

Я не смог найти ничего в руководстве по phpdocо свойствах массива.

Answer 1

/** @var array */ для вашего protected $stuff - правильный синтаксис. На странице справки phpDocumentor для @var показано «Тип данных должен быть действительным типом PHP (int, string, bool и т. Д.)», А «array» - это допустимый тип PHP.

Некоторые IDE также начали распознавать /** @var ElementType[] */, чтобы указать «это массив, все элементы которого имеют тип ElementType». Этот синтаксис будет доступен в следующей версии phpDocumentor.