phpDoc-为持有类实例的私有成员编写文档


phpDoc - Documenting for private members holding class instances

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

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

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

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

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

我想删除变量类型之前的"''"。

前导斜杠可能是因为phpDoc处理名称空间的方式。带前导''的类在全局命名空间中。除了将您的类放入自己的名称空间(正如您所说的,您将使用这个特定的类)之外,我找不到一个设置可以使phpDoc省略全局名称空间类上的前导斜杠。