PHPDocumentor是一个用PHP写的强大的文档自动生成工具，对于有规范注释的PHP程序，能够快速生成具有结构清晰、相互参照、索引等功能的API文档，文档可以转换为PDF、HTML、CHM等格式的文档，这样非常有利于代码的升级、维护、移交等操作。
为什么要使用phpDocumentor？
PHPDocumentor可以直接从代码的注释中找到有用的信息，并生成索引帮助文档，这样你就不必要再去翻找那些复杂的代码文件，PHPDocumentor并不是要取代API文档，而是提供一种帮助文档或者是附加文档，从下面的几个方面被证明很有帮助：
提供一个API库或者索引文档，使用在线搜索作为一个插件运行在项目中，例如WordPss或者是PyroCMS长期运行的复杂项目，快速查找可供使用的函数或方法
文档模板
PHPDocumentor拥有多种风格的文档模板，你可以完全自定义文档的输出方式，通过修改CSS文档来调整文档的显示效果，应用到符合你的品牌推广风格的文档样式。
代码分析
phpDocumentor能够提取有趣的信息，并以图形和报告的形式呈现出来。当前的版本支持以下内容：
显示所有子类化和接口实现的继承关系图。报告源代码内联文档中的错误。报告哪些元素标记为已弃用。报告todo在代码中的位置以及要执行的操作。
这个列表只会在将来持续增长，以帮助您确定在哪里投资资源改进代码，从而使您的代码更加稳定和可维护性。
结构和功能
PHPDocumentor是全部采用OOP的思想来编写的，这也是PEAR所推荐的方式，PHPDocumentor的工作原理：
PHPDocumentor扫描指定目录下面的PHP源代码，扫描其中的关键字，截取需要分析的注释，然后分析注释中的专用的tag，生成xml文件，接着根据已经分析完的类和模块的信息，建立相应的索引，生成xml文件对于生成的xml文件，使用定制的模板输出为html文件。
从设计上来说，PHPDocumentor使用了个超类：PhpdocObject和PhpdocError。这是整个PHPDocumentor的基本类，这种方式也是PEAR所推荐的。当你编写应用框架时，最好能够有一个基本的超类，而其他的子类或者是功能类都有一个共同的祖先。
在扫描源代码过程中，PHPDocumentor使用的是类似GREP的形式。PHPDocumentor令人满意的另一方面是其分析结果是以XML形式保存的，这就意味着其他应用程序可以共享这个数据，同时PHPDocumentor也提供了相应的接口，你可以实现这个接口，把API文档生成其他的形式，比如PDF、LATEX、WORD等。目前PHPDocumentor的分析结果可以以HTML形式表现，由于使用了模板机制，可以很方便地定制风格。
使用pear安装使用
安装方式有两种，一是下载源码安装，另一种是通过pear安装。
安装pear
使用dos窗口进入php安装目录，有个文件叫go-pear.bat，如果没有，建议到网上下载go-pear.phar，然后在dos窗口下运行go-pear.phar，从而安装pear。
phpgo-pear.phar
安装phpdoc
PearinstallphpDocumentor
在phpDocumentor成功安装后，php安装目录下会多出来一个phpdoc.bat。这个文件就是我们用来生成文档的批处理文件。
在phpdoc.bat所在目录下，输入
Phpdoc–h
会得到一个phpDocumentor的详细参数列表。先看看最重要的几个吧：
-d这个目录代表着需要生成文档的原始php文件目录（注意是目录）-t这个目录代表着生成的文档存放目录-o这个参数代表着生成的文档格式，例如html格式，参数就是HTML:frames:phpedit
生成文档
生成文档的命令就是：
phpdoc-d"D:\phpdoc\1"-t"D:\phpdoc\1"-o"HTML:frames:phpedit"
可以看到，解析完成后，在目标目录下生成很多html文件，打开index.html文件，就是我们需要的文档。
使用源码安装使用
下载PHPDoc压缩文件（phpdoc.zip），地址如下：