fileheader插件需手动启用auto_add_to_new_file并正确配置模板、变量及supported_filetypes,否则新建文件无作者注释;自定义变量须在settings-user的default对象中显式声明,且保存时自动更新仅对已有合法头部的文件生效。

FileHeader 插件默认不自动插入文件头,必须手动开启 auto_add_to_new_file 并正确配置模板和变量,否则新建任何文件都不会出现作者信息。
为什么新建 .py / .js 文件没生成作者注释?
最常见原因是插件开关未启用,或配置写在了错误位置:
-
auto_add_to_new_file必须设为true,且不能被注释(即不能以//或/* */包裹) - 配置必须写在
Preferences → Package Settings → FileHeader → Settings - User里,Settings - Default的修改会被覆盖 - 改完必须重启 Sublime Text,仅保存设置不生效
- 新建文件后必须立刻保存(
Ctrl+S),且文件名要带后缀(如main.py),否则插件无法识别语言类型
如何让 .vue / .ts / .html 也支持自动头部?
FileHeader 默认只支持 .py、.js、.java 等少数后缀,新增类型需两步补全:
- 在
Settings - User中添加supported_filetypes,例如:"supported_filetypes": ["vue", "ts", "html"] - 进入
Preferences → Browse Packages… → FileHeader → template → header,检查是否存在对应.tmpl文件:
– 没有vue.tmpl就复制javascript.tmpl改名为vue.tmpl
– 没有typescript.tmpl同理;html.tmpl要用<!-- -->包裹变量,不能用//或/* */ - 所有模板中变量必须用双大括号,如
{{author}}、{{create_time}},写死字符串(如直接写@Author: Tom)会导致变量不替换
author / email 等自定义变量怎么生效?
这些值不会自动从系统读取,必须显式声明在 Settings - User 的 Default 对象里:
{
"Default": {
"author": "Your Name",
"email": "you@example.com",
"desc": "Brief description"
}
}
注意:
-
date_format可选,如"date_format": "YYYY-MM-DD HH:mm:ss",影响{{create_time}}输出格式 - 模板里未声明的变量(如
{{last_modified_by}})即使写了也不会报错,但值为空 - 团队协作时建议把这份
Settings - User配置存为项目级sublime-project的settings字段,避免成员各自配置不一致
最容易被忽略的一点:FileHeader 的「保存时自动更新 last_modified_by / time」功能,只在文件已有合法头部的前提下触发——它不会帮你补全缺失的头部,只做增量更新。如果想强制统一头部结构,得先确保每个文件都通过插件新建并保存过一次。











