How can I specify array of objects in PhpDoc [duplicate]

Question

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;

@Jack I examined this question but I can't find answer to my question — Farid Movsumov
– Farid Movsumov, Commented Nov 19, 2012 at 14:17
If this Eclipse thread is to be believed, your syntax should work in future :) — Ja͢ck
– Ja͢ck, Commented Nov 19, 2012 at 14:22
To the best of my knowledge, the format you show above is correct. Its just not widely supported. I do know that PHPStorm uses that format at least. — Wige
– Wige, Commented Nov 19, 2012 at 14:22
@Jack I'm from the future and I can confirm your comment. It works nowadays. — Robin van Baalen
– Robin van Baalen, Commented May 15, 2014 at 21:43

schmijos · Accepted Answer · 2023-04-19 14:37:52Z

24

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 */

edited Apr 19, 2023 at 14:37

answered Nov 19, 2012 at 14:20

schmijos

8,8434 gold badges54 silver badges60 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

gskema Over a year ago

You may also write int[]|string[]

Jens Kohl Over a year ago

There is also a proposed PSR: PSR-5: PHPDoc on Arrays

Collectives™ on Stack Overflow

How can I specify array of objects in PhpDoc [duplicate]

1 Answer 1

1.4.4. Arrays

2 Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1.4.4. Arrays

2 Comments

Linked

Related