用PHPDocumentor生成源码文档

最近在看phpwind9.0的源码，由于在网上找不到具体的开发手册，所以就动了用phpdocumentor生成文档的想法。

PHPDocumentor是一个通用的生成PHP文档的工具，他本身也是用PHP写的。使用起来非常简单。

1.安装

可以手动下载：http://pear.php.net/package/PhpDocumentor/download

之后解压缩就好了

2.使用

以windows为例，cd到解压缩的PHPDocument目录

附上几个常用的命令：

常用命令解释

-f	要进行分析的文件名，多个文件用逗号分割
-d	要分析的目录，多个目录用逗号分割
-t	生成的文档的存放路径
-o	输出的文档格式，结构为输出格式:转换器名:模版目录，例如：HTML:frames:phpedit

使用示例

Phpdoc -d  “C:\ProgramFiles\EasyPHP5\php\PEAR\PHPUnit2” -t “C:\ProgramFiles\EasyPHP5\php\phpunit2doc” -o“HTML:frames:phpedit”

3.使用中遇到的错误

1.找不到php.exe文件

解决方法：

打开phpdoc.bat

修改SET phpCli=C:\usr\local\php\cli\php.exe为计算机指定目录上的php.exe