Vim简单的方法来插入类/方法文档

Question

我可以轻松地执行以下操作：ctrl + d并让它插入文档模板，例如：

  /** Creates a person with a given name and age.
    *
    * @param name their name
    * @param age the age of the person to create 
    */

更好的是，是否有方法或插件可以利用filetype插入适当的方法文档框架？

Answer 1

您可以使用以下代码段插件：

首先，您需要一个代码段引擎，例如ultisnips（首选），snipmate或neosnippet，以及代码段定义f.i.的集合。 vim-snippets

然后，您可以使用以下内容修改可在插件安装文件夹中找到的*.snippet定义：

snippet doc
    /** ${1:blabla}
     *
     * @param ${2:first param}
     * @param ${3:second param}
     */${4}

例如，如果您将其添加到c.snippet，则可以为ant C文件输入doc<Tab>（在插入模式下），模板将以光标突出显示“blabla”。再次点按<Tab>会将光标移动到“第一个参数”，依此类推，直至到达${4}。