如何在线记录PHP函数和类？

Question

我知道PHP代码内联文档有许多不同的标准.这就是我对内联文档的意思,如果有更好的术语,请纠正我:

/**
* This is the description for the class below.
*
* @package    my-package
* @subpackage my-subpackage
* @author     my-name
* @version    my-version
* ...
*/
class orderActions {
...

什么是最好和最广泛接受的内联文档形式？是否有任何工具可以自动生成此类文档,还是必须手动完成？

我对生成手册不感兴趣 - 我想知道如何生成上面注释的代码类型,或"内联文档".

Answer 1

与您发布的内容一样,PHPDoc是一种广泛接受的PHP文档形式.

您可以使用Doxygen自动生成文档.

编辑:在代码中生成内联文档方面,我从来没有遇到过一个可以返回并在项目外部执行此操作的工具.它通常留在IDE的领域,以便在编码时生成模板.

Eclipse实际上做得很好(这是我喜欢Eclipse的少数几件事之一),我相信Netbeans也是如此.任何主要IDE都可能具有协助此类模板生成的功能.

Answer 2

从中选择:

• Doxygen的
• phpDocumentator
• 萨米
• ApiGen
• CakePHP API文档
• phpDox

另请参阅维基百科文章"文档生成器的比较","按语言"部分.