工具&利器

phpdoc注释文档生成

go-pear.phar 下载安装 downLink (有些浏览器会直接显示出来_我是通过遨游浏览器,里的下载器下载的)

下载后复制到你的PHP.exe目录下 如我的: D:\phpStudy\php\php-5.4.45

我用的是phpsutyd 2016 ,出现很多报错信息,还待处理,不过目前可以生成文档了

第一种方法:
第一步:安装pear
使用dos窗口进入php安装目录,有个文件叫go-pear.bat,如果没有,建议到网上下载go-pear.phar,然后在dos窗口下运行 go-pear.phar, 从而安装pear。

php go-pear.phar 

第二步:安装phpdoc

Pear install phpDocumentor 

在phpDocumentor成功安装后,php安装目录下会多出来一个phpdoc.bat。这个文件就是我们用来生成文档的批处理文件。
在phpdoc.bat所在目录下,输入

Phpdoc –h 

会得到一个phpDocumentor的详细参数列表。先看看最重要的几个吧。

-d  
这个目录代表着需要生成文档的原始php文件目录(注意是目录) 
-t  
这个目录代表着生成的文档存放目录
-o  
这个参数代表着生成的文档格式,例如html格式,参数就是
HTML:frames:phpedit

第三步:生成文档
生成文档的命令就是:

phpdoc -d "D:\phpdoc\1" -t "D:\phpdoc\1"  -o "HTML:frames:phpedit"

生成的html文件

可以看到,解析完成后,在目标目录下生成很多html文件,打开index.html文件,就是我们需要的文档,如下图所示。

生成的类参考文档

我查阅的相关资料

一号传送门二号传送门

发表评论