自动生成 PHP 文档？[已关闭]

php documentation-generation documentation

2022-08-30 11:42:47

对于 ActionScript 2，我使用了 NaturalDocs。但是，它对PHP的支持非常差。到目前为止，我已经看过doxygen和phpDocumentor，但在我看来，它们的输出非常丑陋。有没有人有为PHP自动生成文档的经验？我希望能够使用javadoc风格的标签，它们写起来很短，易于记忆。

答案 1

芹菜碱

http://apigen.org/

ApiGen 支持 PHP 5.3 命名空间、包、文档之间的链接、对 PHP 标准类和一般文档的交叉引用、创建突出显示的源代码以及对 PHP 5.4 特征的实验性支持。

多克布洛克斯

http://www.docblox-project.org/

PHP 5.3 兼容 API 文档生成器，适用于各种规模的项目和持续集成。

能够完全解析和转换Zend框架2

答案 2

有两个众所周知且经常使用的工具可以从文档块生成API文档：

phpDocumentor，它是PHP特有的，可能是PHP项目最常用的工具之一
和Doxygen，它更适合C，但被一些人用于PHP。

关于“指南”：我会说这取决于你的项目，但是，至少，我希望看到：

对方法/函数的作用的描述
参数，具有@param type name description of the parameter
返回值，带有@return type description of the return value
例外，与@throws type description of the exception that can be thrown

一件好事是，最近的IDE（例如Eclipse PDT）可以读取和解释这些标记，以便在编码时提供提示;-）

此外，有越来越多的PHP工具将php文档块用于文档以外的其他目的。

例如，PHPUnit允许您使用一些特定的标签来指定一些与测试相关的东西 - 参见注释。