文章来源:http://www.blogdaren.com/post-1610.html
今天发现vim的一个插件--DoxygenToolkit,它会根据配置自动生成注释,主要是license注释、文件注释、函数及类注释,我的配置如下:
let g:DoxygenToolkit_authorName="david, david19842003@gmail.com"
let s:licenseTag = "Copyright(C)\<enter>"
let s:licenseTag = s:licenseTag . "For free\<enter>"
let s:licenseTag = s:licenseTag . "All right reserved\<enter>"
let g:DoxygenToolkit_licenseTag = s:licenseTag
let g:DoxygenToolkit_briefTag_funcName="yes"
let g:doxygen_enhanced_color=1
举个例子,下图是没有注释的代码:
添加License注释:
添加文件头、作者和时间注释:
添加函数注释:
以上分别使用DoxLic、DoxAuthor、Dox命令自动生成,注释的样式和文字完全可配置,在vimrc中添加即可。生成完注释,可以结合
doxygen
自动生成各种格式的文档。
移除了原文章中配置的行号,懒人直接复制即可
另外我是用了插件管理软件,直接复制到bundle文件夹,不起作用,还是需要安装一下的,有点小小的不方便
安装方法是直接复制到。vim/plugin文件夹即可