TBD 生成 API 文档（Generating API Documentation）

Yii 2的API文档生成器

此扩展为Yii框架2.0提供了API文档生成器。

有关许可证信息，请检查LICENSE文件。

​

​

安装

安装此扩展的首选方法是通过composer。

然后运行

php composer.phar require --prefer-dist yiisoft/yii2-apidoc

或添加

"yiisoft/yii2-apidoc": "~2.0.0"

到你的composer.json的require部分。

用法

此扩展提供两个命令：

• api 生成类API文档。
• guide 从标记文件（如yii指南）渲染漂亮的HTML页面。

独立类文档的简单用法：

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

独立指南文档的简单用法：

vendor/bin/apidoc guide source/docs ./output

您可以将它们组合在一起生成类API和指南文档：

# generate API docs
vendor/bin/apidoc api source/directory ./output
# generate the guide (order is important to allow the guide to link to the apidoc)
vendor/bin/apidoc guide source/docs ./output

默认情况下， bootstrap 将使用模板。您可以使用--template=name 参数选择不同的模板 。目前只有 bootstrap 模板可用。

您还可以将yii\apidoc\commands\ApiController and 添加 GuideController 到控制台应用程序命令映射，并在应用程序控制台应用程序中运行它们。

高级用法

以下脚本可用于生成不同目录中的API文档和指南，以及不同语言的多个指南（如在yiiframework.com上完成）：

#!/bin/sh

# set these paths to match your environment
YII_PATH=~/dev/yiisoft/yii2
APIDOC_PATH=~/dev/yiisoft/yii2/extensions/apidoc
OUTPUT=yii2docs

cd $APIDOC_PATH
./apidoc api $YII_PATH/framework/,$YII_PATH/extensions $OUTPUT/api --guide=../guide-en --guidePrefix= --interactive=0
./apidoc guide $YII_PATH/docs/guide    $OUTPUT/guide-en --apiDocs=../api --guidePrefix= --interactive=0
./apidoc guide $YII_PATH/docs/guide-ru $OUTPUT/guide-ru --apiDocs=../api --guidePrefix= --interactive=0
# repeat the last line for more languages

创建指南的PDF

你需要 pdflatex 和 GNU make 。

vendor/bin/apidoc guide source/docs ./output --template=pdf
cd ./output
make pdf

如果所有运行都没有错误，则PDF将 guide.pdf 在 output dir中。

特殊降价语法

我们有一个特殊的语法，用于链接到API文档中的类。有关详细信息，请参阅代码样式指南

创建自己的模板

TDB

使用模型层

TDB