PHPDoc与phpDocumentor API文档生成实践
PHP 项目的 API 文档，整起来其实没那么麻烦，尤其用了PHPDoc和phpDocumentor这对组合之后，效率会高不少。
PHPDoc 的注释格式比较像 Java 的 JavaDoc，注释写清楚了，类、函数、属性都有，直接生成文档不带含糊。
phpDocumentor就是干这个事的利器。它会读取你代码里的 PHPDoc 注释，吐出一份结构清晰、还能点进源码看的 HTML 文档，挺适合团队合作或者开源项目。
装起来也简单，直接用composer require phpdocumentor/phpdocumentor搞定。建议配个.phpdoc.xml配置文件，这样你能控制输出风格、目录啥的，灵活点。
写注释也不用太花里胡哨，像下面这样就够用了：
/**
* 获取用户 ID
*
* @return int
*/
public function getUserId() {
return $this->userId;
}跑命令也直接，vendor/bin/phpdoc或者vendor/bin/phpdoc run都行，默认文档会输出到docs目录里，浏览器打开一看就明白。
哦对，它还有模板系统、依赖、源代码链接这些加分项，用起来感觉还挺全能的。如果你写 PHP 项目还在手动整理接口文档，那真的可以换一下思路。
如果你对文档规范比较感兴趣，可以看看PHP 文档规范与 phpDoc 指南；想了解更多 API 文档生成工具，也可以顺手看看这篇。
写注释没啥神秘的，坚持写就行，配上 phpDocumentor，文档自动化就一步到位了。
文件大小：2.01MB
评论区