@see和@uses标签没有显示phpDocumentor

时间:2014-06-29 17:16:46

标签: php documentation phpdoc

我使用的是phpDocumentor 2.5.0,下面的标签没有显示在文档中(即使一次只完成一次):

//None of these work
 * @see MyClass::someFunction()
 * @see MyClass::someFunction() that does something
 * @uses MyClass::someFunction()
 * @uses MyClass::someFunction() to do something
 * @uses MyClass
 * @uses /MyClass
 * @uses /MyClass::someFunction()

如何将它们添加到文档中?

我没有使用名称空间。

我正在运行这样的phpDocumentor:

phpdoc -d /home/development/code_to_document/ -t /home/development/documentation

1 个答案:

答案 0 :(得分:1)

这些行来自哪些docblock?只要它是真正的文档块: /** * @see MyClass::someFunction() */

并且docblock位于可记录的代码元素(类,方法,函数等)上,然后我希望标记出现,即使在代码项目中找不到MyClass和MyClass :: someFunction()。 / p>

如果您的测试代码符合这些要求,那么您可能发现了一个错误。我建议至少尝试几种不同的输出模板,看看丢失的标签行为是否会持续存在。