如何做好 PHP 项目文档管理？PHPer 开发的必备利器！

对于常年写 PHP 的老司机来说，PHPDoc 一定不会陌生，不过从1.3.0开始，更名为 phpDocumentor。它作为一个用 PHP 写的工具，主要作用是从你的源代码的注释中生成文档，因此在给你的程序做注释的过程，也就是你编制文档的过程。这样也促使你要养成良好的编程习惯，尽量使用规范，也避免了事后编制文档和文档的更新不同步的一些问题。

新的版本加上了对 php5 语法的支持，同时，可以通过在客户端浏览器上操作生成文档，文档可以转换为 PDF、HTML、CHM几种形式，非常的方便。不过，传统使用 PHPDoc 工具需要下载安装，过程繁琐，今天给大家推荐码云 PHP 项目的文档自动生成和托管服务。

1. 首先确保项目的编程语言选项是 PHP

如果不是 PHP，请进入项目设置页面，修改编程语言为 PHP。

2. 点击服务菜单中的 PHPDoc 项目

3. 选择要构建文档的分支以及目录

4. 开始自动生成文档并部署

你可以点击 https://apidoc.gitee.com/mirrors/phpDocumentor2/ 这个链接来预览生成文档的效果。当然，记得把生成的文档链接放到项目首页和介绍处，方便你的项目用户浏览和查阅。

如果大家感兴趣，可以去试试：https://gitee.com

掌握了以上几点，基本上就可以利用码云提供的在线生成 PHPDoc 服务为你工作了，提高工作效率。

关注码云微信公众号：mayunOSC

发现更多优质开源项目：最新推荐 – 码云 – 开源中国

让团队流畅、高效开发：码云企业版 – 码云 – 开源中国​​​​​