Question

我正在使用phpautodocumentor，我正在编写一个类，它扩展了一个完全不同的文件夹中的类，如何在注释中写出我正在扩展该特定类。因为视觉工作室或Aptana中的intellisense不承认。代码工作正常。问题在于记录。它并没有说我在文档中延伸等级

Answer 1

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

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

Answer 2

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

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

如果我在子类或继承的项目上制作文档块，我将坚持只使用除@param和@return之外的标记，以便子文档信息增强父信息而不是替换它。但是，一般情况下，我不会在继承的方法上放置docblock，因为我不需要它来显示父级docblock中已经提供的内容。

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

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

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

PHP autodoc（继承）autodocumentor标记

2 个答案: