Tag: phpdoc

你可以提示一个数组的项目types？

这个问题与这个问题有关： 是否有可能暗示返回数组中的项目的types？ 例如： /** * MyFunction does a lot of things * * @param TClass1 $var1 * @param TClass2 $var2 * @return array[TClass3] //<- I'm trying to express this */ function MyFunction( $var1, $var2 ){ … 我正在使用NetBeans作为一个IDE，它需要（像很多其他PHP IDE一样）function上面的文档块来确定返回值的types。 如果我可以解释一个数组中的期望types，我希望IDE能够为以下情况提供正确的完成： $myTab = MyFunction( $foo, $bar ); foreach( $myTab as $itm ){ $itm->myFi| //offer the completion for […]

为常量编写PHPDocs的正确方法是什么？

我有这个代码： /** * Days to parse * @var int */ const DAYS_TO_PARSE = 10; … 我不认为使用@var是一个常量是正确的，我没有看到任何@constant PHPDoc标记。 什么是正确的方法来做到这一点？

PHP函数注释

只是一个简单的问题：我已经看到一些PHP函数在顶部被注释了，使用一种我不知道的格式： /** * * Convert an object to an array * * @param object $object The object to convert * @return array * */ 我的IDE给我一个下拉select的东西，如@参数和@返回，所以它必须logging在某处。 我试过search谷歌，但它不会在search中包含@符号。 这种评论forms是什么，我可以在哪里find一些信息？

PHPDoc：@return void必要？

是否真的有必要这样做： /** * … * * @return void */ 我有很多方法没有返回值，在注释中放入类似的东西似乎是多余的。 它会被认为是不好的forms离开它？

Netbeans中的variablestypes提示（PHP）

只是好奇，如果netbeans中有一种方法可以为常规variables提供types提示，那么intellisense会提取它。 我知道你可以做的类属性，函数参数，返回types等，但我不知道如何做到这一点常规variables。 这是真正有帮助的情况下，你有一个方法，可以返回不同的对象types（如服务定位器）。 例如： /** * @var Some_Service $someService */ $someService = ServiceLocator::locate('someService'); 之后使用$ someService的地方，netbeans会提供Some_Service类中定义的所有可用的方法。

PHPDoctypes提示对象的数组？

所以，在PHPDoc中，可以在成员variables声明之上指定@var来提示其types。 然后IDE，为前。 PHPEd，将知道它正在使用什么types的对象，并将能够提供该variables的代码洞察力。 <?php class Test { /** @var SomeObj */ private $someObjInstance; } ?> 这很好，直到我需要做一样的对象数组，以便能够得到适当的提示，当我迭代这些对象后来。 那么，有没有办法声明一个PHPDoc标签来指定成员variables是SomeObj的数组？ @var数组是不够的， @var array(SomeObj)似乎不是有效的，例如。