phpphpdoc

How can I specify array of objects in PhpDoc


I use PhpDocumentor2 for generating documentation. I searched for this subject but I can't find specific rule for it. For Example I have class which name is AddressField and I want to specify my $addressFields as array of AddressField objects.

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

Solution

  • phpdoc themselves describe the use of arrays here:

    1.4.4. Arrays

    • undefined: @return array
    • single type: @return int[]
    • multi type: @return (int|string)[]

    The same should apply to variable definitions:

    /* @var Type[] $arr */