如何正确记录phpdocumentor类中的数组属性?

时间:2012-03-03 21:35:53

标签: php phpdoc

我正在尝试找出如何在类中为phpdocumentor正确记录数组属性。

例如:

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

我在phpdoc手册中找不到有关数组属性的任何内容。

1 个答案:

答案 0 :(得分:2)

/** @var array */

protected $stuff是正确的语法。 @var的phpDocumentor手册页显示“数据类型应该是有效的PHP类型(int,string,bool等),”和“array”是一种有效的PHP类型。

某些IDE也开始识别/** @var ElementType[] */以指示“这是一个数组,其元素都是ElementType类型”。这个语法将在即将发布的phpDocumentor版本中提供。