PhpDocumentor 生成文档

Posted 2020-10-03 上善若水-随

最近项目需要phpdoc生成文档，首先安装PhpDocumentor,利用pear安装：
切换用户：
su root
安装PhpDocumentor:

pear install PhpDocumentor
生成文档：

Phpdoc –h 
会得到一个phpDocumentor的详细参数列表。先看看最重要的几个吧。
-d  
这个目录代表着需要生成文档的原始php文件目录（注意是目录） 
-t  
这个目录代表着生成的文档存放目录
-o  

这个参数代表着生成的文档格式，例如html格式，参数就是
phpdoc -d /mnt/www/ci_system_3/application/controllers/api1 -t /mnt/www/sui -o HTML:frames:phpedit
    浏览生成文档结果很让我失望，程序中中文乱码，后google搜索得知，PhpDocumentor的默认编码是：iso-8859-1的，我的项目都是utf8编码的，所以需要把编码改成utf-8才可以。
进入PhpDocumentor的模板目录把模板文件修改成utf-8编码：

cd /usr/share/pear-data/PhpDocumentor/phpDocumentor/Converters
执行字符串查找并替换命令：

find ./ -name \'*.tpl\' | xargs sed -i \'s/iso-8859-1/utf-8/g\'
    执行完毕之后再生成项目文档，浏览项目中中文乱码解决。
以后如果项目换了别的编码，也可以用此命令修改过去。

　　

很简单,大功告成,界面太丑,可以自定义界面.看手册.