Как указать массив объектов в PhpDoc

Я использую PhpDocumentor2 для создания документации. Я искал эту тему, но не могу найти для нее конкретного правила. Например, у меня есть класс с именем AddressField, и я хочу указать мои $ addressFields как массив объектов AddressField.

/**
 * @var AddressField[]
 */
private $addressFields;

person Farid Movsumov    schedule 19.11.2012    source источник
comment
@Jack Я изучил этот вопрос, но не могу найти ответа на свой вопрос   -  person Farid Movsumov    schedule 19.11.2012
comment
Если верить этому потоку Eclipse, ваш синтаксис должен работать в будущее :)   -  person Ja͢ck    schedule 19.11.2012
comment
Насколько мне известно, приведенный выше формат верен. Это просто не пользуется широкой поддержкой. Я знаю, что PHPStorm по крайней мере использует этот формат.   -  person Wige    schedule 19.11.2012
comment
@Jack Я из будущего и могу подтвердить ваш комментарий. Сейчас это работает.   -  person Robin van Baalen    schedule 16.05.2014


Ответы (1)


phpdoc сами описывают использование массивов здесь:

1.4.4. Массивы

  • undefined: @return array
  • одиночный тип: @return int[]
  • мульти-тип: @return (int|string)[]

То же самое должно относиться к определениям переменных:

/* @var $arr Type[] */
person schmijos    schedule 19.11.2012
comment
Вы также можете написать int[]|string[] - person gskema; 19.05.2017
comment
Также предлагается предлагаемый PSR: PSR-5 : PHPDoc о массивах - person Jens Kohl; 26.09.2017