Question

我使用Pear安装了phpDocumentor 2，如phpdoc.org所述。这样做时，我编写了我的评论

 /**
  * Calls class1
  * @see class2
  * @access public
  */
 class class1 {

 }

 /**
  * Calls class2
  * you can {@link class1}
  */
 class class2 {

 }

第一个不起作用，除非你说@see class2 Class 2，而第二个不管怎么办都不行。它只是看起来像打印，而不是作为内联标签读取花括号。所以，我的问题是 - 我在这里做错了吗？还有其他人遇到过类似的东西吗？我下载了phpDocs 1.x并且没有这个问题，但是如果可能的话我想要phpDocs 2 ..

谢谢！

Answer 1

phpDocumentor 2.x尚未实现1.x中提供的内联链接标记（＆＃34; {@ link}＆＃34;）。它在TODO列表中。我建议也在这里使用@see标签，但显然你不能将其作为内联标签。

我希望@see标签只能使用目标类名称（＆＃34; @see class2＆＃34;），而不需要描述文本（＆＃34; @see class2 Class 2＆＃34;）。我会认为您描述的行为是一个错误，可以在此处报告 - https://github.com/phpDocumentor/phpDocumentor2/issues

顺便说一下，@ access标签没有关于类本身的上下文。 public / protected / private的可见范围仅适用于类方法和类属性，而不适用于类本身。此外，它在PHP4天后被添加到phpDocumentor 1.x中，之后在PHP中可用的可见范围（在PHP5中添加）。因此，它实际上不再有用了。即使在1.x中，如果使用PHP5针对为PHP5编写的代码运行，代码范围关键字也会覆盖@access标记所说的任何内容。我不相信phpDocumentor 2.x甚至不屑于实现@access标签，这是正确的。

phpDocumentor 2标签不起作用

1 个答案: