README

安装

将 mikehaertl/yii2-apidoc-vim 添加到您的 Vundle 配置中。

或者您可以从这里下载文件，解压包并将 docs/ 目录移动到您的 ~/.vim 目录。

如果安装后帮助信息不可用，您可以在 VIM 中尝试执行以下命令

:helptags ~/.vimrc/doc

此插件无需配置。

:help yii/web/Controller

但请注意，我们使用正斜杠（/）而不是反斜杠（\）作为命名空间分隔符。这是必要的，因为当搜索标签时，Vim 使用正则表达式。所以任何反斜杠都会表示搜索模式的开始，您必须输入例如 yii\\base\\Controller。自动完成也不会很好用。

注意：仅在您想要构建帮助文件的自己的版本时需要。

在空目录中开始，并通过 composer 安装 yii2-apidoc-vim 包

composer require mikehaertl\yii2-apidoc-vim dev-master

现在您可以使用 apidocvim 命令从任何源文件提取为 Vim 格式的文档

./apidocvim api path/to/some/source/code /path/to/output/dir

您也可以使用 update-all 命令自动从当前安装的 vendor/ 目录中的 yii2 包提取文档文件。

您可以在 src/templates/views 中的视图文件中进行修改，并调整 src/templates/ApiRenderer.php 中的渲染方法。