在vim中写入函数注释

时间:2016-10-10 15:27:00

标签: vim vim-plugin

/********************************************************* 

 * Function Name:
 * Parameter:
 * Purpose:

 ********************************************************/

我总是如上所述手动编写功能注释,但这似乎浪费时间。

  1. 有没有有用的vim插件来做这种事情?

  2. 如何在vim中将此实用程序映射到快捷键(如'< Leader> cm')?

  3. 谢谢:)

2 个答案:

答案 0 :(得分:3)

您可以手动使用缩写或映射,但我建议您搜索适合您的代码段/模板插件。存在many

BTW,存在能够根据函数签名填充javadoc或doxygen注释的插件。这比你严格要求的更进了一步。

答案 1 :(得分:2)

片段就像类固醇上的内置:abbreviate一样,通常带有参数插入,镜像和内部多个停止。第一个非常着名(并且仍然广泛使用)的Vim插件之一是snipMate(受 TextMate 编辑器的启发);不幸的是,它不再维持;虽然有a fork。现代替代方案(虽然需要Python)是UltiSnips。还有更多内容,请参阅this list on the Vim Tips Wiki

有三件事要评估:第一,摘录引擎本身的功能,第二,作者或其他人提供的片段的质量和广度;第三,添加新片段是多么容易。