1

我正在使用phpDocumentor2为我的代码编译文档。包含 @throws 和 @uses 的 DocBlocks 并没有完全按照我的预期进行编译。

具体来说,FQSEN 没有在文档输出中呈现。

例如

/**
 * Constructs the object and loads data.
 * 
 * This constructor invokes the gatherData and populates the object's instance variables.
 *
 * @uses gatherData() to load in the data associated with this object.
 * @uses load() to populate the data gathered.
 */

产生...

生成的文档的屏幕截图

请注意,“gatherData()”和“load()”方法名称没有出现在输出中。然而,他们的描述确实如此。

我看到@throws 标签有类似的效果。

这是预期的行为吗?我滥用标签了吗?

4

1 回答 1

2

如果这些是某个类的方法,您应该像这样指定它们

@uses SomeClass::gatherData() to load in the data associated with this object.

原始的 phpdocumentor 不支持命名空间,您可能需要切换到phpdocumentor2版本。

于 2013-07-06T17:02:34.310 回答