主要为 phpdoc 2.0 安装及错误排除笔记,环境为 win7 + apache 2.4 + php 5.3.9
/* 2012.7.18 Maple 撰写 */
phpDocumentor 官方网站:http://www.phpdoc.org/
先不负责任的比较一下两个版本的差异吧.....phpdoc 1.4.4phpdoc 2.0
需求php 版本似乎没限制
pearPHP 5.3.3 以上
pear
iconv extension
XSL extension
样板html 多种
chmhtml 一种
tag 命令似乎是一样的似乎是一样的
语系 bug默认语系 iso-8859-1
非此语系会乱码 ( 可能还有救 )默认语系 utf8
转档命令些微不同,但不能两个都装命令比 1.4.4 版少
若要安装 1.4 版的,网络上有很多写得好的文章 (我的参考数据) :
http://pkwbim-programming-note.blogspot.tw/2008/01/phpdocumentor-0.html
http://pkwbim-programming-note.blogspot.tw/2008/01/phpdocumentor-1.html
http://phorum.study-area.org/index.php/topic,48764.msg247116.html
以下主要是 phpdoc 2.0 安装笔记,环境为 win7 系统,apache 2.4 + php 5.3.9
首先确定 php 环境是否有 pear
1.若没有 php/pear 数据夹
检查是否有 php/go-pear.bat
2.没有 php/go-pear.bat 的话
请执行原本安装 PHP 的 php.exe 文件(如果还有留着的话)
然后选择修改,加装 pear 上去
装好后,应该就会看到 go-pear.bat
(安装前最好备份一下 httpd.conf 可能会异动到唷)
3.检查 php/pear 底下数据夹,是否有其他基本的安装文件
若只有一个文件,代表还没装
执行 go-pear.bat ,中间就按Y或下一步,一路安装到底
若出现 PHP_PEAR_PHP_BIN 错误,请观看解决文章
http://www.reai.us/windows-fix-php_pear_php_bin-is-not-set-correctly
其实就是 pear.bat 里面的 PHP_PEAR_PHP_BIN 的 php.exe 路径设定不正确 改掉就好了
安装 phpdoc ,请先检查环境中 pear.bat 文件在哪
开启 cmd ,切换到 pear.bat 的所在目录,执行以操作
安装 phpdocs 1.4 版的命令是
pear install -o PhpDocumentor
安装 phpdocs 2.0 版的命令是
先检查连的到官方网址 ( 如果我理解没有错的话 )
pear channel-discover pear.phpdoc.org
执行安装
pear install phpdoc/phpDocumentor-alpha
1.安装过程中要是出现超出内存限制或下载失败,请去修改 php.ini 内存及暂存文件大小的设定
2.移除 phpdocs 就是改使用 pear uninstall 的命令
3.欲安装 2.0 版,需检查 PHP 是否有安装 iconv 及 XSL ,且 php.ini 有载入
若未安装,其安装方式跟加装 pear 一样是执行 php 安装文件,选择修改后附加
产生文档,用 cmd 执行命令
开启 cmd ,切换到 phpdoc.bat 的所在目录,执行命令
若要查询可用命令,可打 phpdoc -h
1.4 版执行命令
phpdoc -o -d -t -i
1.4 版命令说明 ( 2.0 版没有 -o 的属性 )
http://jax-work-archive.blogspot.tw/2011/12/php-documentor-phpdoc.html
我个人比较喜欢 样板 HTML:frames:earthli ,而 HTML:Smarty:PHP 则跟 PHP 官网风格类似
另外1.4 版默认网页语系是 iso-8859-1,因此会有乱码问题
简单的解决方法 : 可使用 .htaccess 更改编码 ( 适用于网址浏览 HTML 文档乱码 )
一劳永逸的解决方法:
将PHP安装目录 dataphpDocumentorphpDocumentorConverters 下的文件,把模板内容有 iso-8859-1 全部替换成 utf-8
( 若找不到,可能在 phppearphpDocumentor 下 )
但是 PDF 的乱码无解,因为好像是用二进制方式产生 ( 我 try 了好久,搞不定...放弃... )
2.0 版执行
phpdoc run -d -t -i
若执行中出现
DOMDocument::loadXML(): Input is not proper UTF-8, indicate encoding !
请检查转出来的文件 structure.xml ,用 notepad++ 开启是否中文有出现乱码
结尾要是为文"章"、增"加"等特定中文字容易会遇到此问题,
解决方式:不要让这些字当做此行最后结尾字!在后面加上其他的符号,如.或。 即可以解决
2012.7.12 补充
win7 安全性更新后 cmd 执行会一直跳出无法载入 php 文件的错误消息
Could not open input file: phpdoc.php
不知道是不是权限被系统锁住
解决方式:改用自己写 .bat 文件,内容写为
"PHP安装路径/php.exe" "PHP安装路径/phpdoc.php" -d -t -i
存档后,点两下执行即可