Press "Enter" to skip to content

PHP 自动生成文档 phpdocumentor

PHPDocumentor是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档。老的版本是phpdoc,从1.3.0开始,更名为phpDocumentor,新的版本加上了对php5语法的支持,同时,可以通过在客户端浏览器上操作生成文档,文档可以转换为PDF,HTML,CHM几种形式,非常的方便。

phpDocumentor是一个非常强大的文档自动生成工具,利用它可以帮助我们编写规范的注释,生成易于理解,结构清晰的文档,对我们的代码升级,维护,移交等都有非常大的帮助。

1、安装

Yii2集成了http://www.yiiframework.com/doc-2.0/ext-apidoc-index.html

使用 composer 安装,新版会提示phpdocumentor版本不兼容,建议修改 

vi composer.json

增加:

“yiisoft/yii2-apidoc”: “~2.1.0”

执行 composer update


2、使用

vendor/bin/apidoc api source/directory ./out

说明:source/directory 是哪些文件要生成文档的文件,比如:frontend/controllers

source/directory 源代码目录

./out 文档生成目录

Comments are closed.