在vim中使用Atom的docblockr的类似插件？ （自动文档方法）

Question

是否有任何Vim插件在Atom中编码docblockr时为每种方法插入文档模板？我用Google搜索，但结果无关紧要。

Answer 1

所有文件类型都没有通用插件，但是针对特定ft的一些插件：

e.g

• https://github.com/sumpygump/php-documentor-vim代表php。
• https://github.com/heavenshell/vim-jsdoc代表javascript。

编辑：另一种方法是使用代码段。

在github而不是vim.org中搜索vim插件总是一个好主意。

Answer 2

我只熟悉Sublime Text DocBlockr，但Atom DocBlockr是其中的一个端口，所以它们在功能上应该是相同的。

在尝试了多次失败尝试后，我发现没有任何东西可以匹配DocBlockr的强大功能。我在Windows上使用GVim 8.0。

@MisterOccan提到的

vim-jsdoc已经接近但只适用于JavaScript。您可以将其设置为请求输入（通过let g:jsdoc_allow_input_prompt = 1中的.vimrc），这样您就可以按照与DocBlockr类似的方式设置值。

对于PHP开发，我发现的最好的是更新的PDV v2 from TobyS。这与UltiSnips插件相结合，允许通过生成的文档进行制表（通过 Ctrl + j / Ctrl + k ）。所以这实际上给出了DocBlockr的相对接近的近似值。

然而

1. PDV v2没有生成@return值我不知道为什么（只是我遇到的许多琐事中的一个）
2. PDV v1（最新版本为php-doc-modded的克隆确实会生成@return值，但缺少格式设置和标记输入的功能
3. 与DocBlockr一样，所有PHP文档都没有很好地格式化与垂直排列的类型和描述相同的程度
4. 他们都没有adding extra tags
的自动填充功能
5. 类型提示似乎在DocBlockr中比我尝试的Vim插件更好用

编辑：您可以使用Tabular plugin实际修复PHP文档块格式，并使用以下命令：

:Tabularize /\$\w*/l1

这将匹配$xxx行的所有\$\w*（@param）变量名称并适当填充它们（使用左对齐（l）一个空格（{ {1}}））。

我尝试过的其他插件：

• Rican7/php-doc-modded：这会在每个功能的末尾添加注释
• spf13/PIV