安装
PHPDocumentor2
是一个用 PHP 写的工具,对于有规范注释的 php 程序,它能够快速生成具有相互参照,索引等功能的 API 文档。 官网传送门- 我本地使用的是composer安装,主要原因是因为我用
PEAR
一直下载不成功,哭死在墙上了。 - 介绍一下
PEAR
安装方法
pear channel-discover pear.phpdoc.org
pear install phpdoc/phpDocumentor
- 以下是composer安装方法
sudo mkdir phpDoc
sudo composer require phpdocumentor/phpdocumentor
使用
- 找到
phpDoc
目录
cd vendor/bin
- 你会发现有一个
phpdoc
文件
./phpdoc run -d /usr/local/var/www/project/app/Http/Controllers/OpenApi -t ~/personal
执行完之后你就会发现在
~/personal
文件夹下生成了对应的 api 文档,终于可以好好玩耍了….常用参数
参数 注解 h 帮助信息 V 当前版本 f 要进行分析的文件名,多个文件用逗号隔开 d 要进行分析的目录,多个目录用逗号分割 t 生成的文档的存放路径