您的位置:首页 > 编程语言 > PHP开发

PhpDocumentor生成代码说明文档

2013-05-29 23:49 363 查看
如何使用PhpDocumentor,参考这篇文章就可以了

http://pkwbim-programming-note.blogspot.com/2008/01/phpdocumentor-0.html

不过,我还是在安装使用的时候,遇到了一点问题。

运行->cmd

进入 php所在目录 d:\php\ 执行go-pear.bat

system|local

输入local,然后根据提示,一步一步来,输入yes,然后就是一路“回车”

这样pear就安装好了

之后,就是安装PhpDocumentor了,

>pear help (查看pear的命令帮助)

>pear help install (查看 install命令的用法)

使用pear来安装,也可以直接下载 http://downloads.sourceforge.net/phpdocu/PhpDocumentor-1.4.2.zip?modtime=1206909537&big_mirror=0

>pear install -o phpdocumentor (安装phpdocumentor)

安装完毕后,进入 D:\php5\PEAR\PhpDocumentor

>phpdoc –parseprivate -o HTML:Smarty:PHP -f E:\web\db.php -t E:\web\doc

-f参数,指定db.php文件,生成文档

>phpdoc –parseprivate -o HTML:Smarty:PHP -f E:\web\ -t E:\web\doc

-d参数,指定目录,生成文档

如果注释是中文的,一定要执行 iso-8859-1 到 utf-8 的替换,否则生成出来是乱码。(把 \php5\PEAR\PhpDocumentor\phpDocumentor 里的(含子目录)的文件里的所有 iso-8859-1 的字串全部换成 utf-8)

指定 -o CHM:default:default 可以生成 chm,不过这个时候,还需要借助“HTML Help Workshop” 来编译成 chm,不过可恶的是,能通过 HTML Help Workshop 编译成chm,但是仍然是乱码,查看源文件后,代码中却是正常中文,暂时无解,或许使用其他软件可以编译成正常中文,还没有尝试
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签:  php PhpDocumentor