How do I properly document an array property in a class for phpdocumentor?

Question

I'm trying to find out how to properly document an array property in a class for phpdocumentor.

Ex:

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

I couldn't find anything in the phpdoc manual about array properties.

Have you tried * @var string[] ? See as well: PHPDoc type hinting for array of objects? — hakre
– hakre, Commented Mar 3, 2012 at 21:37
Well, there are about 30 properties in the parent class and only one is an array. In the multiple classes extending the parent I can quickly see what I'm dealing with. — James L.
– James L., Commented Mar 3, 2012 at 21:57
I'm hoping it will work with both.. will let you know soon if PHPDocuemntor accepts this — James L.
– James L., Commented Mar 3, 2012 at 21:59

Gricey · Accepted Answer · 2012-09-17 12:28:29Z

2

/** @var array */ for your protected $stuff is the proper syntax. The phpDocumentor manual page for @var shows "The datatype should be a valid PHP type (int, string, bool, etc),", and "array" is such a valid PHP type.

Some IDEs have also begun recognizing /** @var ElementType[] */ to indicate "this is an array, whose elements are all of type ElementType". This syntax will be available in an upcoming version of phpDocumentor.

edited Sep 17, 2012 at 12:28

Gricey

1,4521 gold badge22 silver badges38 bronze badges

answered Mar 5, 2012 at 15:59

ashnazg

6,7282 gold badges34 silver badges40 bronze badges

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

Collectives™ on Stack Overflow

How do I properly document an array property in a class for phpdocumentor?

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related