fileheader插件需手动启用自动插入功能,配置"auto_add_to_new_file": true,并正确设置author、date_format等变量;快捷键仅在源码视图生效,团队协作应使用project_settings统一约束。

FileHeader插件装完没反应?检查是否启用了自动插入
装了 FileHeader 插件但新建文件没自动生成注释,大概率是开关没打开。它默认不自动触发,得手动配置。
- 打开
Preferences → Package Settings → FileHeader → Settings - 确认
"auto_add_to_new_file": true已启用(不是注释掉的状态) - 如果只想要特定语言生效,还要配
"fileheader_custom_template": {}里的supported_filetypes
常见错误:改了 User 设置却忘了重启 Sublime Text,或者把配置写在了 Default 文件里(会被覆盖)。
怎么让作者名、创建时间按自己习惯显示?别硬改模板,用变量就行
FileHeader 的模板支持动态变量,比如 ${author}、${date}、${time},不用写死字符串。
- 作者名从
Settings里的"author": "Your Name"读取,改这里比改模板更安全 - 日期格式由
"date_format": "Y-m-d H:i:s"控制,注意大小写:H是24小时制,i是分钟,s是秒 - 如果项目需要统一用中文星期,得自己加变量,比如
${weekday_zh}—— 这个原生不支持,得靠插件扩展或换用DocBlockr类工具
容易踩的坑:${file_name} 和 ${file_path} 在未保存文件里返回空,别依赖它们做逻辑判断。
快捷键 Ctrl+Alt+T 插不了头?可能是快捷键冲突或作用域不对
这个快捷键默认绑定在「当前光标位置插入」,但它只在源码视图(source view)下有效,比如你在 Markdown 或控制台里按,就完全没反应。
- 确认当前文件有正确 syntax:右下角显示
Python、JavaScript等,而不是Plain Text - 检查快捷键是否被其他插件劫持:进
Preferences → Key Bindings搜file_header,看是否有重复或 disabled 条目 - 想改成
Ctrl+Shift+H?直接在 User Key Bindings 里加一条:{"keys": ["ctrl+shift+h"], "command": "add_file_header"}
性能影响几乎为零,但如果你在超大日志文件里频繁触发,会卡顿——这不是插件问题,是 Sublime 对未分块大文件的通用限制。
团队协作时文件头格式不一致?靠 project_settings 统一约束
单靠个人 Settings 不足以保真,尤其当多人共用一个仓库时。Sublime 支持 per-project 配置,优先级高于全局设置。
- 菜单栏
Project → Edit Project,在"settings"下加"file_header": {...}块 - 重点配
"author"(强制留空则报错)、"description_format"(比如必须含@desc)、"license" - 路径相关的变量如
${project_name}只在此模式下可用,全局设置里无效
最常被忽略的一点:Git 提交前不会校验文件头,所以即使配置了 required 字段,漏掉也不会阻断提交——得靠 pre-commit hook 补位。











