Vim 自动文件头注释与模板定义

Vim 自动文件头注释与模板定义

• 在vim的配置文件.vimrc添加一些配置可以实现创建新文件时自动添加文件头注释，输入特定命令可以生成模板。

使用方法

---

• 插入模式输入模式输入seqlogic[Enter]创建时序逻辑框架
• 新创建一个文件 gvim test.c 自动添加头部注释
• F2映射文件头注释，命令行模式文件内按F2自动添加
• F11映射注释，命令模式按F11出现注释行

Verilog模板生成

---

vim中输入seqlogic或者comlogic点击回车即可替代为模板

"###################    verilog   ##########################
:ab seqlogic always@(posedge clk or negedge rst_n)<Enter>begin<Enter>if(rst_n==1'b0)<Enter>begin<Enter>end<Enter>else<Enter>begin<Enter>end<Enter>end
"生成时序逻辑框架块

:ab comlogic always@(*)<Enter>begin<Enter>end
"生成组合逻辑框架块
"###################    verilog   ##########################

文件头注释自动生成

---

"###################    set file head start  #########################
"autocmd创建新文件自动调用setfilehead()函数
autocmd BufNewFile *.v,*.sv,*.cpp,*.c,*.h exec ":call Setfilehead()"
func Setfilehead()
    call append(0, '/***********************************************')
    call append(1, '#')
    call append(2, '#      Filename: '.expand("%"))
    call append(3, '#')
    call append(4, '#        Author: Clough - clough@gmail.com')
    call append(5, '#   Description: ---')
    call append(6, '#        Create: '.strftime("%Y-%m-%d %H:%M:%S"))
    call append(7, '# Last Modified: '.strftime("%Y-%m-%d %H:%M:%S"))
    call append(8, '***********************************************/')
"    call append(9, '')
endfunc

"map F2 to creat file head comment
"映射F2快捷键，生成后跳转至第10行，然后使用o进入vim的插入模式
map <F2> :call Setfilehead()<CR>:10<CR>o
"###################    set file head end   ##########################

文件内部注释快捷键生成

---

"###################    set comment start  #########################
func SetComment()
    call append(line(".")  , '//**************** comment start ********************')
    call append(line(".")+1, '//**************** comment end   ********************')
endfunc

"映射F11快捷键，生成后跳转至下行，然后使用O进入vim的插入模式
map <F11> :call SetComment()<CR>j<CR>O
"###################    set comment end   ##########################

参考资料

---

[1]. vim 自动添加头注释