PHPDocumentor安装与使用

phpDocuemtor官网：http://www.phpdoc.org/

通过pear安装，进入dos的php目录，输入pear install -a PhpDocumentor。如果想使用web接口，则必须首先改变一个配置，参考：http://developer.51cto.com/art/200912/166582.htm。

终端：phpdoc -h   可以查看所有的指令，选几个重要的：

-d     源php文件的路径

-t      生成文档后文档的存放路径（最好为其单独创建一个文件夹）

-dn   包的名字（默认为default，最好改成项目的名字）

-dc   目录的名字（默认为default，最好改成项目的名字）

-ti     文档标题  这是首页上的大标题

-o     生成的文档的模板格式，这个应该有很多种可以选择，不过我只选择：HTML:Smarty:PHP（感觉比较美观）

 

phpDocumentor的安装很简单,
如果通过pear自动安装
在命令行下输入  pear install PhpDocumentor
如果是手动安装
则在http://manual.phpdoc.org/下载最新版本的PhpDocumentor（现在是1.4.2），把内容解压即可.

phpdocumentor的使用也很简单, 分为命令行模式和web模式:

命令行模式
在phpDocumentor所在目录下，输入
php –h
会得到一个详细的参数表，其中几个重要的参数如下：
-f 要进行分析的文件名，多个文件用逗号隔开
-d 要分析的目录，多个目录用逗号分割
-t 生成的文档的存放路径
-o 输出的文档格式，结构为输出格式：转换器名：模板目录。
例如：phpdoc -o HTML:frames:earthli -f test.php -t docs

Web模式
在新的phpdoc中，除了在命令行下生成文档外，还可以在客户端浏览器上操作生成文档，具体方法是先把PhpDocumentor的内容放在 apache目录下使得通过浏览器可以访问到
点击files按钮，选择要处理的php文件或文件夹，还可以通过该指定该界面下的Files to ignore来忽略对某些文件的处理。
然后点击output按钮来选择生成文档的存放路径和格式.
最后点击create，phpdocumentor就会自动开始生成文档了，最下方会显示生成的进度及状态，如果成功，我们就可以通过查看生成的文档了，如果是pdf格式的，名字默认为documentation.pdf。

http://www.laruence.com/2009/04/21/680.html