PHP autodoc(Inheritance) autodocumentor 标签答案

【问题标题】：PHP autodoc(Inheritance) autodocumentor tagsPHP autodoc(Inheritance) autodocumentor 标签
【发布时间】：2010-12-14 21:01:53
【问题描述】：

我正在使用 phpautodocumentor，我正在编写一个类，它扩展了一个位于完全不同文件夹中的类，我如何在 cmets 中写入我正在扩展该特定类。因为 Visual Studio 或 Aptana 中的智能感知无法识别。代码工作正常。问题正在记录。它并没有说我在文档中扩展了某某类

【问题讨论】：

标签： php phpdoc

【解决方案1】：

没有用于扩展的标记，您的 IDE 应该从代码中实现它，好的代码 - 例如 PDT、Zend Studio 或 PhpStorm - 可以。但是，有一个 @see 标记来引用文档中的其他内容。

 /** 
  * this class extends main_class.
  * @see main_class, TEST_CONST
  */
  subclass extends main_class {
  }

【讨论】：

【解决方案2】：

（从 phpDocumentor 的角度来看，一般的 docblocks，以及 IDE 弹出帮助...）

理想情况下，IDE 应该从代码中识别出当前类是另一个类的子类，并在子类的弹出帮助中显示来自父文档块的信息。但是，如果您在子类本身上放置一个 docblock 并在其中写入与父 docblock 重复部分的信息（短描述、长描述、@param、@return），那么子 docblock 信息有时会“覆盖”父信息，有效地防止弹出窗口显示任何父信息。

如果我在子类或继承项上创建文档块，我将坚持只在其中使用标签而不是@param 和@return，以便子文档块信息增加父信息而不是替换它。不过，一般来说，我不会在继承的方法上放置文档块，因为我不需要它来显示超出父文档块中已经给出的任何内容。

（从我不知道的“phpautodocumentor”和我不使用但被认为是Eclipse衍生产品的Aptana的角度来看......）

我假设您主要指的是 IDE 的弹出帮助，当您突出显示子类时会显示父类信息。

相反，如果您指的是与 IDE 文件编辑分开生成实际类文档的东西，那么除了代码本身之外，通常不需要任何东西。 phpDocumentor 肯定会单独从代码中识别类继承，并且会在大多数输出转换器中将继承的内容显示在它们自己的部分中。如果“phpautodocumentor”是别的东西，那我不能说它的功能是什么。

【讨论】：