安装“koroFileHeader”插件并配置settings.json文件,设置customMade和cursorMode模板,保存文件或使用快捷键Ctrl+Alt+I即可自动生成含作者、日期等信息的文件头注释。

VSCode 可以通过插件和配置实现自动添加文件头注释,无需手动输入。关键在于使用合适的扩展并正确设置模板。
安装支持文件头注释的插件
最常用且功能完善的插件是 “koroFileHeader”,它支持多种语言,能自动生成文件头和函数注释。
- 打开 VSCode 扩展商店(快捷键 Ctrl+Shift+X)
- 搜索 “koroFileHeader” 并安装
- 安装后重启编辑器或重新加载窗口
配置文件头模板
安装完成后,需要在 VSCode 设置中自定义注释格式。
打开设置(Ctrl+,),切换到“设置”(JSON)模式,编辑 settings.json 文件:
{
"fileheader.customMade": {
"Author": "your-name",
"Date": "Do not edit",
"LastEditTime": "Do not edit",
"Description": ""
},
"fileheader.cursorMode": {
"Description": "",
"Author": "",
"Date": "",
"LastEditTime": ""
}
}
其中:
- customMade 定义新建文件时自动插入的字段
- cursorMode 是通过快捷键添加函数注释时的模板
- “Do not edit” 表示由系统自动填充时间
触发文件头自动添加
koroFileHeader 默认不会在创建新文件时立即插入注释,需触发一下:
- 保存文件(Ctrl+S),部分情况下会自动添加
- 使用快捷键 Ctrl+Alt+I 手动插入文件头
- 可在设置中启用保存时自动添加(查看插件文档是否有对应选项)
某些项目中,也可以结合 .vscode/settings.json 做项目级配置,确保团队统一风格。
基本上就这些。配置一次后,新建文件时就能快速生成标准注释头,提升代码规范性。










