我想利用NetBeans for PHP的变量类型注释功能,但是我在决定类型本身时遇到了麻烦。
我已经掌握了语法(我的变量名为$clause
):
/* @var $clause type */
但是当涉及到用某些东西代替type
时,我不确定该使用什么。我使用gettype($clause)
来确定有问题的变量类型,它输出string
,但是在NetBeans中自动完成评论的下拉列表中没有string
选项。
此外,所列的选项至少对我来说是陌生的,我不认为开发人员每次需要确定使用的变量类型时都要使用gettype
。
谁能给我一些建议,使用的类型?是我确定的string
,还是这是用户定义的类型?
我注意到在这里的文档中,作为示例给出的类型是Book
和Movie
,它们与给定示例中的class
名称匹配。我的案例不包含class
,但是没有类似的示例。
嗯,我想你是指PHPDoc,不是吗?这不是Netbeans的特性…
从长远来看,数据类型并不重要,它只是帮助你设计自我文档化的代码。
最后,如果$clause
变量确实包含一个类名(通常是一个字符串),DocBlock将看起来像:
/**
* @var $clause string Some class name.
*/
注意docblock必须以一个斜杠和两个星号开头。
@var子句的格式为"变量名"、"数据类型"one_answers"描述"。