phpdoc2操作实例

PHPDocument对于有规范注释的php程序，可以快速生成API文档，以下是安装与使用步骤：

本例环境：windows7,、PHPDocument 2.8.1、php 5.4n、Apache 2.4.9

安装PHPDocument的方法很多，本例采用php pear安装，pear安装配置方法本例不再赘述。

cmd中进入php安装目录，依次执行：

pear channel-discover pear.phpdoc.org（注册phpdoc）

pear remote-list -c phpdoc（获取可安装列表）

pear install phpdoc/phpDocumentor（执行下载安装）

安装过程需要下载文件

安装完成，使用方法：

phpdoc -d "原项目绝对路径" -t "生成api文档的路径"

详细参数可执行 phpdoc -h 进行查询

生成出的html格式文档，可能会出现页面响应时间过长的问题，原因可能是页面对googleapis的引用，修改位置如下：

若安装使用的为PHPDocument 1.x版本，安装和使用过程与此稍有不同。

需要注意的是1.x版本可能会出现生成文档页面不显示或是乱码问题，需要对模板文件做一些修改：

模板位置在 \pear\PhpDocumentor\data\templates

本例模板位置：E:\phpStudy\php54n\pear\PhpDocumentor\data\templates

修改文件（不完全）：

header.tpl、index.tpl

删除 <?xml version="1.0" encoding="iso-8859-1"?>
修改 iso-8859-1 => utf-8