PHPDocumentor安装与使用以及一般问题的处理

一、安装PHPDocumentor

1、Pear安装

a、可以一步步安装，开始安装相关依赖包，依赖包有2个，分别是XML_Parser和XML_Beautifier

在命令行中输入pear install XML_Parser安装XML_Parser。

D:/Program Files/PHP>pear install XML_Parser

在命令行中输入pear install XML_Beautifier安装XML_Beautifier。

D:/Documents and Settings/Administrator>pear install XML_Beautifier

下面才正式安装PHPDocumentor

在命令行中输入pear install PhpDocumentor安装PhpDocumentor。

D:/Documents and Settings/Administrator>pear install PhpDocumentor

b、当然，一步步安装比较麻烦，还有一种一步到位的安装方式

进入dos的php目录
输入pear install -a PhpDocumentor

D:/Documents and Settings/Administrator>pear install -a PhpDocumentor

2、手动安装

下载后，如果希望使用命令行接口，解压到任意路径（假设在C:/Program Files/），
修改C:/Program Files/PhpDocumentor-1.4.2/phpdoc.bat
把第一行修改SET phpCli=C:/usr/local/php/cli/php.exe
令等号右边的值为php.exe的路径
我的机器是SET phpCli=D:/php5/php.exe

在命令行输入C:/Program Files/PhpDocumentor-1.4.2/phpdoc,其实是一个批处理文件
会出现一个dos界面，给你选择ini文件。
后面就不知道了。

如果想使用web接口，你必须先把apache和php装好，把PhpDocumentor-1.4.2这个文件夹
拷贝到文档根目录下，然后在浏览器url栏输入：
http://localhost/PhpDocumentor-1.4.2/phpdoc.php
然后浏览器会自动跳转，选择index.html,后面的操作就很简单了。

二、使用

a、Doc下面的命令方式

相关说明：如果需要把对应目录中所有的文件都生成文档，那使用下面命令
phpdoc -o HTML:Smarty:PHP -d D:/install/apachephp/wamp/www/thinkphp -t D:/install/apachephp/phpdoc/thinkphp

相关说明：如果需要把对应目录中某个文件生成文档，那使用下面命令
phpdoc -o HTML:Smarty:PHP -f D:/install/apachephp/wamp/www/thinkphp/infile.php -t D:/install/apachephp/phpdoc/thinkphp
具体的命令用法，请使用phpdoc -h查看去比较，以上都是生成HTML文档

b、WEB界面生成

在新的phpdoc 中，除了在命令行下生成文档外，还可以在客户端浏览器上操作生成文档，具体方法是先把PhpDocumentor 的内容放在apache 目录下使得通过浏览器可以访问到，访问后显示如下的界面：

点击files 按钮，选择要处理的php 文件或文件夹，还可以通过该指定该界面下的Files to ignore 来忽略对某些文件的处理。

然后点击output 按钮来选择生成文档的存放路径和格式.

最后点击create ，phpdocumentor 就会自动开始生成文档了，最下方会显示生成的进度及状态，如果成功，会显示

Total Documentation Time: 1 seconds

done

Operation Completed!!

然后，我们就可以通过查看生成的文档了，如果是pdf 格式的，名字默认为documentation.pdf 。

三、中文乱码问题

a、Zend中使用

下面的目录便是模板文件存放处：

　　C:/Program FilesZendZend Studio for Eclipse - 6.0.1/plugins/com.zend.php.phpdocumentor_6.0.1.v20080601/Resources/phpdocumentor/phpDocumentor/Converters/HTML/frames/templates/default/templates

　　而且模板结构良好，只需要修改head.tpl、index.tpl、blank.tpl、top_frame.tpl等文件，将其中的 ISO-8859-1改成GBK编码方式即可，而样式文件的修改同样如此，如修改stylesheet.css，先找到

　　C:/Program FilesZendZend Studio for Eclipse - 6.0.1/plugins/com.zend.php.phpdocumentor_6.0.1.v20080601/Resources/phpdocumentor/phpDocumentor/Converters/HTML/frames/templates/default/templates/media

目录下的文件，然后进行修改即可。

　　注意：上述修改是针对默认的php文档样式进行的，phpdoc提供了多款样式，为了修改对应样式的模板和样式文件，只需要替换上述地址中的default为样式名称即可找到文件所在地址

b、

自己安装的话，那就直接搜索utf-8，然后把搜索到的所有都替换成自己的编码，例如GBK等，保存就可了啦；