使用phpdoc生成类的说明文档

安装phpdoc

pear install PhpDocumentor

常用的phpdoc命令参数

-f 要进行分析的文件名，多个文件用逗号隔开

-d 要分析的目录，多个目录用逗号分割

-t 生成的文档的存放路径

-o 输出的文档格式，结构为输出格式：转换器名：模板目录

以我开发的日志类为示例：

phpdoc -o HTML:frames:earthli -f Logger.php -t /doc

访问doc中的index.html即可以看到文档。

phpdoc规范中有很多标签，一般使用几个常用的标签即可方便的阅读，具体如下：

@access private|public|protect 类的访问权限

@param integer|string|array|... 方法参数的类型

@return integer|string|array|... 返回值的类型

@var integer|string|array|... 类变量的类型

具体代码和文档说明点击这里下载。