为了解决一校友在安装和使用phpDocumentor过程中遇到的问题,自己闲时也折腾了一下这个东西,总结见下:
一.定义:
自己刚听到这个词时还不知道这个是什么东西,干啥用的,就去百度了一下,说道:
"phpDocumentor是用php语言写的一个非常强大的文档自动生成工具,利用它可以帮助我们编写规范的注释,生成易于理解,结构清晰的文档,对我们的代码升级,维护,移交等都有非常大的帮助”;
二.安装:
我实验的环境是win8 + wamp集成环境(php5.4.16),
首先是查看自己的php.exe同目录下是否存在pear这个文件,比如我的php.exe是E:\wamp\bin\php\php5.4.16
如果没有就点击这个http://pear.php.net/go-pear.phar下载go-pear.phar文件,然后将下载的文件放到php.exe同目录下,比如我的是放在E:\wamp\bin\php\php5.4.16
为了防止出现权限不够导致的错误(以前就被坑过),我使用管理员的权限(这个很重要)进入到dos,win8如下
其他的win系统可以查看 http://jingyan.baidu.com/article/e73e26c0f87c2424adb6a7f1.html
然后在dos命令行中切换到php.exe目录下,输入php go-pear.phar,如下图:
按回车默认system然后继续。以下是默认的pear的临时、数据、配置、测试、执行目录的设置:
按下回车提示如下:
就这么简单的安装成功了,查看php.exe同目录就可以看到pear这个文件了
然后执行操作 pear install PhpDocumentor
上面那个警告说明PhpDocumentor已经不是最新的了,以后用phpdocumentor这种写法(pear install phpdocumentor)
看到这个install ok 就说明PhpDocumentor安装成功了!
同时在我的这个目录下
E:\wamp\bin\php\php5.4.16\pear
会有以下文件
三.使用PhpDocumentor
输入phpdoc -h会有以下提示
用到最多的几个参数:
-f 要进行分析的文件名,多个文件用逗号隔开
-d 要分析的目录,多个目录用逗号分割
-t 生成的文档的存放路径
-o 输出的文档格式,结构为输出格式:转换器名:模板目录。
执行以下命令:
phpdoc -o HTML:frames:earthli -f E:\www\webdev2\trunk\include\Controller\EsfController.php -t docs (其中EsfController.php是php代码的路径, docs是生成的html API的存放路径)
然后查看docs的目录如下会有html API
E:\wamp\bin\php\php5.4.16\docs\Include\Controller
用浏览器访问那个API会得到如下结果
参考博客:
http://www.cnblogs.com/bugY/archive/2012/07/06/2578972.html
http://luchuan.iteye.com/blog/954147
http://blog.163.com/chen_r200509/blog/static/3411130020098294223106/
http://www.laruence.com/2009/04/21/680.html
来源:https://www.cnblogs.com/ryanlamp/p/4769471.html