安装与使用phpdocumentor自动生成文档

1,754 阅读1分钟

phpdocumenter简介

在公司维护内部类库时,为了使用更加方便,需要同时维护代码与文档。而文档经常落后代码很多,于是我们需要通过注释与标签自动生成文档类似javadoc,而在php领域就是phpdocumentor了。

安装

官网里的安装文档,有上面说了有三种方法,我就说两种

1.PHAR

先下载phpDocumentor.phar:下载链接,放在项目根目录中,然后再项目根目录执行命令

 php phpDocumentor.phar -d . -t docs/api

-d代表要扫描的文件夹,这里代表这个项目,-t代表输出文档到哪个文件夹,这里是此项目的docs/api目录,也可以省略-t选项,默认输出到output文件夹。

2.composer

需要注意:这种安装方法不推荐,因为phpdocumentor和本项目的依赖有可能会发生冲突。 执行composer命令

composer require --dev phpdocumentor/phpdocumentor dev-master

然后在项目根目录执行

vendor\bin\phpdoc -d  .\src\ -t ./doc

-d与-t选项作用与上述是相同的,最终在输出的文件夹里,浏览器查看index.html就可以了。

使用

phpdocumentor的标签就不一一细讲了,可以看下官网的详细介绍标签的列表

最后说一下想要注释代码时自动生成标签,phpstrom直接就有此功能,vscode只需要安装一个PHP DocBlocker拓展即可。