Shell 自动生成简介
2025-02-17
功能说明
这是一个 Vim 配置文件,用于在创建新的 Shell 脚本时自动生成文件头部注释。主要功能:
- 自动添加 Shell 解释器声明
- 插入作者信息
- 添加创建日期
- 生成文件说明模板
配置代码
# Vim 基本设置
set ignorecase
set cursorline
set autoindent
# 为 .sh 文件设置自动处理函数
autocmd BufNewFile *.sh exec ":call SetTitle()"
# 定义文件头部生成函数
func SetTitle()
if expand("%:e") == 'sh'
call setline(1,"#!/bin/bash")
call setline(2,"#********************************************************************")
call setline(3,"#Author: zhangsan.tk")
call setline(4,"#Username: zhangsan ")
call setline(5,"#Date: ".strftime("%Y-%m-%d"))
call setline(6,"#FileName: ".expand("%"))
call setline(7,"#URL: https://www.zhangsan.tk")
call setline(8,"#Description: Annotated script")
call setline(9,"#********************************************************************")
call setline(10,"")
endif
endfunc
# 将光标移动到文件末尾
autocmd BufNewFile * normal G使用方法
创建或编辑 Vim 配置文件:
vim ~/.vimrc将上述代码复制到配置文件中
保存并退出
效果展示
当创建新的 Shell 脚本时,会自动生成如下格式的文件头:
#!/bin/bash
#********************************************************************
#Author: zhangsan.tk
#Username: zhangsan
#Date: 2024-01-20
#FileName: test.sh
#URL: https://www.zhangsan.tk
#Description: Annotated script
#********************************************************************自定义修改
可以根据需要修改以下内容:
- 作者信息
- 网站地址
- 注释格式
- 其他 Vim 设置
提示: 建议根据个人或团队规范修改注释模板,保持统一的代码风格。