如何在phpdocumentor的类中正确记录数组属性?
问题描述:
我想了解如何正确地为phpdocumentor文档中的数组属性。如何在phpdocumentor的类中正确记录数组属性?
例:
<?php
class foo {
/**
* This holds something important
* @var string
*/
protected $junk;
/**
* This holds an important array of strings
* @var ???????
*/
protected $stuff = array();
// ...
}
?>
我无法找到有关阵列性能的PHPDoc的手动什么。
答
/** @var array */
对于您的protected $stuff
是正确的语法。 @var的phpDocumentor手册页显示“数据类型应该是一个有效的PHP类型(int,string,bool等)”,而“array”是这样一个有效的PHP类型。
一些IDE也开始认识到/** @var ElementType[] */
表示“这是一个数组,其元素都是ElementType类型”。该语法将在即将发布的phpDocumentor版本中提供。
你有没有试过'* @var string []'?另请参见:[PHPDoc类型提示对象的数组?](http://stackoverflow.com/q/778564/367456) – hakre 2012-03-03 21:37:57
'@var array' ?? – 2012-03-03 21:42:46
在netbeans中,它似乎接受@var string []。谢谢 – 2012-03-03 21:49:10