PHP Documentor 文档化

前言

团队已经到了需要进一步规范代码输出的环节,在这之前,所有的项目文档都没有一个很好的生成文档方法,导致沟通上的低效和技术债务的快速积累。

先从 php 开始,我们先来做一个示范,通过 PhpDocumentor 来生成我们的文档,以后就可以将注释与文档编写的工作一并规范下来。

PhpDoc 官网:http://www.phpdoc.org/

Wikipedia: https://en.wikipedia.org/wiki/PHPDoc https://en.wikipedia.org/wiki/PhpDocumentor

百度百科:http://baike.baidu.com/link?url=n9z0sRm12o-xsZ8Torj64P4SO6PUfLA0TaVtKUhSbhKDtw1kGyZEEdrK-Huuxu4__VDVwY3NPm4b6vTtQSnOvK

上线步骤:

1. 安装 PEAR 以及 PhpDocumentor 包

sudo apt-get install php-pear
sudo pear channel-discover pear.phpdoc.org
sudo pear install phpdoc/phpDocumentor

安装成功后,应该可以执行命令:phpdoc -h

2. 生成文档

-d 指定一个代码目录,就可以将目录内的文件生成 html 的文档输出到 -t 指定的目录中。

phpdoc -d ./src -t ./docs/api

3. 指定模板

通过加入 --template 参数,可以指定生成的 html 使用的模板,默认可用的模板可以参照官网提供的列表。

phpdoc -d ./src -t ./docs/api --template="responsive-twig"

【转载请附】愿以此功德,回向 >>

原文链接:https://www.huangwenchao.com.cn/2015/11/php-documentor.html【PHP Documentor 文档化】

发表评论

电子邮件地址不会被公开。 必填项已用*标注