The most widely used documentation standard in the PHP world is PHPDoc. It is derived from JavaDoc. A large number of IDEs support PHPDoc, which means they can automate documentation and you can gain code completion and other features from it.
Several tools exist to autogenerate documentation from PHPDoc code annotations. PHPdocumentor already mentioned elsewhere is the most prominent, but you can also use Doxygen which allows for a wider range of documentation formats
Update: phpDocumentor is quite outdated and cannot properly work with PHP5.3 code (tried closures?). There is (currently) two worthwhile alternatives to look at: DocBlox and phpDox.
发布评论
评论(3)
看看 PhpDocumentor
Have a look at PhpDocumentor
PHP 世界中使用最广泛的文档标准是 PHPDoc。它源自 JavaDoc。大量 IDE 支持 PHPDoc,这意味着它们可以自动化文档编写,并且您可以获得代码补全和其他功能从它。
有几种工具可以从 PHPDoc 代码注释自动生成文档。 PHPdocumentor 已经在其他地方提到过是最突出的,但您也可以使用 Doxygen 它允许更广泛的文档格式
更新: phpDocumentor 已经过时了,无法正确使用 PHP5.3 代码(尝试过闭包吗?)。 (目前)有两个值得考虑的替代方案: DocBlox 和 phpDox。
The most widely used documentation standard in the PHP world is PHPDoc. It is derived from JavaDoc. A large number of IDEs support PHPDoc, which means they can automate documentation and you can gain code completion and other features from it.
Several tools exist to autogenerate documentation from PHPDoc code annotations. PHPdocumentor already mentioned elsewhere is the most prominent, but you can also use Doxygen which allows for a wider range of documentation formats
Update: phpDocumentor is quite outdated and cannot properly work with PHP5.3 code (tried closures?). There is (currently) two worthwhile alternatives to look at: DocBlox and phpDox.
看看http://manual.phpdoc.org/HTMLframesConverter/DOM/default
Take a look at http://manual.phpdoc.org/HTMLframesConverter/DOM/default