phpDoc - 记录持有类实例的私有成员

时间:2012-07-25 13:18:16

标签: php phpdoc

我有一个课程要记录。有一个变量保持类实例,它将在构造函数中初始化。我想知道如何记录(或放置标签)以便正确反映变量类型。

到目前为止我已经这样做了:

/**
 * Holds the instance of ParseMessage class
 *
 * @access private
 * @var ParseMessage
 */
 private $_parse_message;

为此成员生成的文档如下所示:

Holds the instance of ParseMessage class
$_parse_message : **\ParseMessage**

我想在变量类型之前删除这个'\'。

1 个答案:

答案 0 :(得分:1)

由于phpDoc如何处理命名空间,因此可能存在前导斜杠。具有前导\的类位于全局名称空间中。除了将您的类放入其自己的命名空间(正如您所说的那样,使用此特定类),我找不到一个设置会使phpDoc省略全局命名空间类的前导斜杠。