使用phpdocumentor2生成项目文档

phpdocumentor2简述

在开发一个大型的项目中，项目文件往往会越来越多，这时如果我们寻找一个类文件，想知道他的功能时，可能需要到一个很深的目录结构中去寻找，而且我们很多时候并不是想研究这个类文件的代码，而是想看看这个文件的作用和类文件中包含了哪些方法，这时我们会想如果有一份这样的文档在手边就好了，phpdocumentor就是帮我们生成这样的文档的工具。

phpdocumentor2的安装

有很多种方法可以按照phpdocumentor，这里要展示的是个人常用的方法，通过composer方式来安装phpdocumentor。

phpdocumentor在packagist上的项目地址是：https://packagist.org/packages/phpdocumentor/phpdocumentor

执行如下命令即可安装phpdocumentor:

composer require phpdocumentor/phpdocumentor

生成的vendor目录下的目录结构如下：

phpdocumentor2的使用

phpdocumentor生成项目文档的功能是基于phpdoc块来的，关于phpdoc可以参考phpdocumentor2官方文档：http://www.phpdoc.org/docs/latest/guides/docblocks.html

phpdocumentor2的使用其实非常简单，只要简单的执行如下命令就能生成api文档了：

phpdoc run -d <SOURCE_DIRECTORY> -t <TARGET_DIRECTORY>

-d指定的是项目目录或者是具体的文件地址，-t指定的是生成的api文档要存放的位置。

下面以php的微型框架slim为例：



执行完毕后可以在目标文件夹看到如下的目录结构：



用浏览器访问其中的index.html文件，可以看到：



注意phpdocumentor2不仅可以生成api文档，通过指定–template=”checkstyle”参数还能检查你的文件中的phpdoc是否规范，下面是一个例子：

!使用phpdocumentor2生成项目文档](https://img-blog.csdn.net/20151115164035986)

打开target目录下的checkstyle.xml文件可以看到如下内容：