可使用KoroFileHeader插件、Code Snippets自定义片段、正则替换或Settings.json配置实现VSCode自动插入文件头注释:1. 安装KoroFileHeader并配置fileheader.customMade;2. 通过用户代码片段为语言定义file-header触发词;3. 利用正则匹配空文件头并批量替换;4. 在settings.json中启用fileheader.configObj.autoAdd自动添加功能。

如果您在VSCode中编写代码时希望自动插入标准化的文件头注释,但当前编辑器未配置相应功能,则可能是由于未安装或未正确设置注释模板插件。以下是实现该目标的多种方法:
本文运行环境:MacBook Air,macOS Sequoia。
一、使用KoroFileHeader插件
KoroFileHeader是一款专为VSCode设计的文件头与函数注释生成工具,支持自定义模板、自动更新修改时间及作者信息。
1、打开VSCode,点击左侧活动栏的扩展图标(或按快捷键Cmd+Shift+X)。
2、在搜索框中输入KoroFileHeader,找到作者为“OBKoro1”的插件并点击“安装”。
3、安装完成后,按下Cmd+Shift+P调出命令面板,输入并选择“File Header: Configure Current File Header”。
4、在弹出的settings.json中添加或修改fileheader.customMade字段,例如:
{"Author": "YourName", "Date": "Do not edit", "LastEditTime": "Do not edit", "Description": ""}。
5、新建或打开一个文件,按下Cmd+Alt+T,即可插入预设的文件头注释。
二、通过Code Snippets自定义片段
VSCode原生支持用户级代码片段功能,可为不同语言创建触发关键词,快速插入固定格式的头部内容。
1、按下Cmd+Shift+P,输入“Preferences: Configure User Snippets”,回车后选择对应语言(如“javascript”)。
2、在打开的javascript.json中,添加名为“file-header”的新片段,内容包含prefix、body和description字段。
3、在body数组中逐行写入注释模板,例如:"// @Author: YourName", "// @Created: ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}"。
4、保存文件后,在JavaScript文件中输入file-header并按Tab键,即可展开完整头部。
三、使用Auto Rename Tag配合正则替换
当已有统一命名规范的文件且需批量补全头部时,可借助正则表达式与多光标编辑能力实现高效注入。
1、打开目标文件夹,在VSCode中使用Cmd+Shift+F打开全局搜索框。
2、启用正则模式(点击.*图标),输入匹配空文件开头的模式:^(\s*)$(?=\n\S)。
3、在替换框中填入所需头部内容,例如:
// ====================
// @File: ${TM_FILENAME}
// @Time: ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}
// ====================
4、点击“全部替换”,确保仅作用于无内容的文件顶部空白行。
四、配置Settings.json启用保存时自动添加
通过修改VSCode设置,使每次保存特定类型文件时自动检查并补全文档头部,无需手动触发。
1、按下Cmd+, 打开设置界面,点击右上角“打开设置(JSON)”图标。
2、在settings.json中添加如下配置:
"fileheader.configObj": {
"autoAdd": true,
"prohibitAutoAdd": [".md", ".txt"]
},
3、同时确认已启用"fileheader.cursorMode": false以避免光标干扰。
4、重启VSCode或重新加载窗口(Cmd+Shift+P → Developer: Reload Window)使配置生效。










