phpdocumentor是一款可以生成代码注释文档的插件,用起来及其方便。
我们只要遵守他的注释规则然后生成文档即可。
我这里用的是phpdocumentor1.4.4版本。
首先进行安装,我这里安装的很顺利,用的PHP直接包含了go-pear.phar 没在这个上面多费功夫。
直接使用命令行自动安装。(要使用管理员权限打开命令行)
然后直接进到go-pear.phar所在目录。
pear install phpdocumentor
然后就会自动下载phpdocumentor,我这里自动下载的是1.4.4的版本。(最新已经到2.X了吧)
还可以手动进行安装。(这里没有尝试,可以自行谷歌)
安装成功之后在php目录下输入phpdoc -h 如果弹出帮助页面(命令介绍,都是英文)说明成功。
然后就可以进行操作。
首先准备一个按照注释规则进行注释的文件。
然后输入命令 phpdoc -f 文件位置 -t 生成文件输入位置 -o 输出的模板
例:phpdoc -o HTML:frames:earthli -f D:\lamppr\www\backend\program\core\sql.php -t F:\phpdocumentor\new1
然后打开生成文件的位置点开index即可。