推荐新手用fileheader.author设全局作者名,fileheader.customMade支持字段级控制、适合团队统一模板,且优先级更高;二者均需字符串格式,不可省略引号。

作者信息不会自动从 Git 或系统读取,必须显式配置;否则生成的 @Author 字段为空或显示默认占位符。
fileheader.author 和 fileheader.customMade 选哪个?
两者都能设作者名,但用途不同:
-
fileheader.author是全局作者名,用于所有语言的文件头和函数注释,简单直接,推荐新手用 -
fileheader.customMade支持字段级控制(如"Author": "Your Name"),还能配"LastEditors"、"Description"等,适合需要统一模板的团队 - 如果同时设了
fileheader.author和fileheader.customMade.Author,后者优先级更高 - 别漏掉引号——JSON 中值必须是字符串,写
"Author": Your Name会报错
想自动读 Git 用户名?别信“git config user.name”硬编码
在 fileheader.customMade 里写 "Author": "git config user.name" 不会执行命令,只会原样输出那串文字。
- 真正能动态取 Git 名的方式只有
${user}变量(仅 koroFileHeader 支持),但它依赖插件内部调用git config user.name,需确保终端能执行该命令且项目已git init - 更稳的办法是:在终端运行
git config --global user.name "Zhang San",再配fileheader.author: "Zhang San",避免运行时失败 - Windows 下若用 WSL,注意 VSCode 启动方式——从 Windows 资源管理器打开时,插件可能读不到 WSL 的 Git 配置
Python 文件头注释缩进错乱?检查模板顶格写法
Python 模板若带前置空格,会导致整个文件代码右移一格,PEP 8 直接报错。
- 模板中每行必须顶格(无空格、无 tab),例如:
"# @Author: ${author}"✅,而不是" # @Author: ${author}"❌ - 不要在
fileheader.customTemplates.python里写"head": " #!/usr/bin/env python",头部 shebang 行也得顶格 - 确认
editor.insertSpaces和editor.detectIndentation设置一致,否则插件插入时用空格、你编辑时用 tab,混用会破坏对齐 - 如果用了
fileheader.configObj.autoAdd: true,新建 .py 文件后立刻检查首行是否多出空格——这是最常被忽略的“静默错误”
更新时间(LastEditTime)不随保存变化?这不是 bug
${update} 或 LastEditTime 字段默认不会在每次 Ctrl+S 时刷新,这是插件的明确设计逻辑。
- 首次创建文件时,
Date和LastEditTime都写入当前时间;后续只响应手动命令File Header: Update File Header(默认快捷键Ctrl+Alt+T) - 想保存即更新?得禁用插件的自动更新机制,改用
editor.codeActionsOnSave+ 自定义任务,但会丢失跨语言兼容性,且 Python/Go 等语言的注释格式容易错位 - 别把
LastEditTime当作 Git 提交时间——它和git log -1 --format="%ad"完全无关,只是本地编辑记录 - 如果你团队真需要“保存即更新”,建议统一约定:每天晨会前手动跑一次
Ctrl+Alt+T批量刷新,比改配置更可靠
最易被忽略的点:不同语言模板必须单独配 fileheader.customTemplates,否则 JavaScript 文件里冒出 Python 风格的 # 注释,或者 Python 文件里出现 /**,这种错位在 PR 审查时才暴露,修起来反而更费时间。


















