koroFileHeader是VS Code中真正可用的头部与函数注释生成插件,需配置autoUpdate:true、正确设置LastEditTime等空字段,并按语言指定annotationStr(如Python用#),函数注释需光标在定义行首且支持声明式语法。

File-Header-Comment-Helper 并不是 VS Code 官方市场中真实存在的插件 —— 搜索结果里找不到它,安装后也不会生效。你真正需要的是 koroFileHeader,它是目前最稳定、配置最灵活、支持语言最全的头部与函数注释生成插件。
koroFileHeader 必须改的配置项:避免日期/编辑时间不更新
koroFileHeader 默认不会自动更新 LastEditTime 和 LastEditors,除非你显式开启:
-
"fileheader.configObj"中必须设"autoUpdate": true -
"LastEditTime"和"LastEditors"字段值不能留空,也不能写成"Do not edit"(这是旧版误导写法) - 正确写法是直接写字段名,值留空字符串:
"LastEditTime": "",插件才会在保存时自动填充
常见错误配置:
"fileheader.customMade": {
"LastEditTime": "Do not edit", // ❌ 这样 autoUpdate 就失效了
"LastEditors": "Do not edit"
}
正确最小配置片段:
"fileheader.customMade": {
"Author": "your-name",
"Date": "",
"LastEditors": "",
"LastEditTime": "",
"Description": ""
},
"fileheader.configObj": {
"autoAdd": true,
"autoUpdate": true,
"prohibitAutoAdd": ["json", "md", "yml"]
}
不同语言要用不同注释风格:别硬套 C 风格到 Python
koroFileHeader 支持按语言切换注释符号和模板,但默认不区分。如果你在 Python 文件里看到 // 开头的注释,说明没配 annotationStr:
- JavaScript/TypeScript/C/C++:用
{"head":"//","middle":"//","end":"//"} - Python:必须改成
{"head":"#","middle":"#","end":"#"}或 Docstring 风格(三引号) - Go/Rust 等需额外配
fileheader.fileHeaderTemplate指定每种语言的完整模板
Python 用户建议直接禁用 koroFileHeader 的头部自动生成,改用官方支持更好的 Python Docstring Generator 插件,它能解析 def f(a: int, b: str = "x") -> bool: 并生成带类型提示的 @param a: int。
函数注释快捷键失效?检查光标位置和函数签名格式
Ctrl+Alt+T(Windows)或 Cmd+Alt+T(macOS)触发函数注释时,失败原因往往很具体:
- 光标必须严格落在函数定义行的第一列或函数名正上方,中间有空格或缩进都会识别失败
- 函数体不能是箭头函数表达式体:
const fn = () => "ok"不支持;必须是声明式:function fn() {}或const fn = function() {} - TypeScript 泛型如
getData<t>()</t>会被截断为getData(),参数推导丢失,此时要手动补全@template T - 如果函数含解构参数(
({ id, name }) => {}),koroFileHeader无法提取字段,得换用Document This(但注意它也不支持嵌套解构)
koroFileHeader 的核心价值不在“全自动”,而在于可控的模板 + 可预测的触发时机。最容易被忽略的是:它从不分析业务逻辑,所有 @description 和 @param 的语义都得你填——生成只是起点,不是终点。


















