如何让VSCode自动添加文件头注释？-VSCode-PHP中文网

如何让VSCode自动添加文件头注释？

幻影之瞳

发布： 2025-09-27 15:50:01

原创

828人浏览过

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

如何让vscode自动添加文件头注释？

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": ""
  }
}

登录后复制

其中：