vim自动添加文件注释

最新推荐文章于 2024-03-05 18:58:26 发布

敬畏技术

最新推荐文章于 2024-03-05 18:58:26 发布

阅读量2.3k

点赞数

分类专栏： vim

本文链接：https://blog.csdn.net/xu_ya_fei/article/details/45645013

版权

vim 专栏收录该内容

5 篇文章 0 订阅

订阅专栏

咱们注释代码规范出来后，我就想着手动添加注释不但麻烦而且浪费时间，我用的vim编辑器，所以就利用业余时间简单看了一下vim自动添加注释的方法。vim添加注释的方法目前有两种，一种是手动在.vimrc中添加配置，另一种是下载一个插件：DoxygenToolkit，先说说DoxygenToolkit插件，这个插件的使用方法百度上一搜一大堆，但是再使用后认为他有一个比较大的缺点就是不够灵活，不能够完全的符合咱们的注释规范，比如“版权声明”和“历史记录”里面就没有。他的优点是比较全面包括文件头注释函数头注释等等。所以选择配置.vimrc文件，在里面添加：
"按F4在lua文件中添加文件头注释
"map <F4> :call FileTitleDet()<cr>'s
map <F4> :call AddFileTitle()<cr>'s
function AddFileTitle()
    call append(0,"--")
    call append(1,"-- 版权声明: 暂无")
    call append(2,"-- 文件名称: ".expand("%:t"))
    call append(3,"-- 创建者 : 许亚飞 ")
    call append(4,"-- 创建日期: ".strftime("%Y-%m-%d %H:%M"))
    call append(5,"-- 文件描述: ")
    call append(6,"-- 历史记录: 无")
    call append(7,"--")
    "echohl WarningMsg | echo "Successful in adding the copyright." | echohl None
endf

但是函数头注释目前也没有搞好，虽然照着文件头注释的样子写了写，但是没有达到预期效果：在光标所在的函数上添加函数头，而是添加在文件头了。