讲师中心 微信公众号
AI工具推荐 视频效率加速

Sublime自动生成文件头部注释,规范代码习惯从这里开始

梦辰小哥_7595

梦辰小哥_7595

发布时间:2026-06-22 11:36:19

|

133人浏览过

|

来源于php中文网

原创

FileHeader插件装完默认不生效,必须手动启用"auto_add_to_new_file": true并重启Sublime Text;还需配置supported_filetypes、对应.tmpl模板及大小写敏感的{{author}}等变量,且语法识别正确才触发。

sublime自动生成文件头部注释,规范代码习惯从这里开始

FileHeader 插件装完默认不生成任何注释,必须手动开启 auto_add_to_new_file 并重启 Sublime Text 才能生效——这是 90% 用户卡住的第一步。

怎么让新建文件自动加头?先开总开关再配语言

FileHeader 不靠“新建动作”触发,只认配置项 auto_add_to_new_file 的布尔值。打开 Preferences → Package Settings → FileHeader → Settings - User,确保有且仅有一行未被注释的配置:

{"auto_add_to_new_file": true}
  • 别写在 Settings - Default 里——会被覆盖,且升级后丢失
  • 别用 // 或 /* */ 注释掉这行,否则等于没写
  • 改完必须彻底退出 Sublime Text(macOS 尤其注意:关闭窗口 ≠ 退出进程),再重开
  • 新建文件后右下角必须显示对应语法(如 JavaScript),若显示 Plain Text,插件直接跳过

为什么 .vue / .ts / .html 没反应?supported_filetypes + .tmpl 缺一不可

FileHeader 默认只对 .py、.js、.java 等少数后缀生效。想支持 .vue、.ts、.html,得补全两处:

Sublime Text Build Linux版
Sublime Text Build Linux版

Sublime Text Linux x86-64 deb 安装包。官方也提供 rpm、tar.xz 和软件源安装方式。

下载
  • 在 Settings - User 中添加:"supported_filetypes": ["vue", "ts", "html"](注意:用小写英文名,不是 .vue 或 vue.js)
  • 进 Preferences → Browse Packages… → FileHeader → template → header,确认存在对应 .tmpl 文件:
    – 没有 vue.tmpl 就复制 javascript.tmpl 改名
    – 没有 typescript.tmpl 同理
    – html.tmpl 必须用 <!-- --> 包裹变量,不能用 // 或 /* */

作者名、邮箱、日期这些变量为啥不替换?大小写和模板必须严丝合缝

变量必须用双大括号语法,且拼写、大小写必须和 Settings - User 中完全一致:

  • 在 Settings - User 里声明:
    {"Default": {"author": "Zhang San", "email": "zhang@example.com"}}
  • 模板里必须写成 {{author}}、{{email}},写成 {{Author}} 或 @Author: Zhang San 都不会替换
  • 新建文件后必须立刻保存为带后缀的文件(如 index.vue),否则 Sublime 无法识别语言类型,不渲染模板
  • {{create_time}} 默认是文件创建时间;若需保存时动态更新日期,得用 on_pre_save 自定义插件 + datetime.now().strftime("%Y-%m-%d")

保存时自动补头部?FileHeader 做不了,得自己写 Python 插件

FileHeader 对保存事件响应弱,也不判断已有头部是否合规。真要团队级规范(比如 CI 要求头部必须存在、日期必须是保存时刻),就得监听 on_pre_save:

  • 插件路径:Packages/User/auto_file_header.py
  • 检查开头 3 行是否含 # -*-、/**、// 等标记,有则跳过
  • 模板从 Packages/User/file_header_template.json 加载,避免硬编码
  • 调用 view.insert(edit, 0, text) 必须传 edit 对象,位置必须是 0(文件开头)
  • 别用 on_post_save——它已写入磁盘,改了也白改

真正容易被忽略的是:插件里正则匹配头部时,必须用 re.MULTILINE,否则 ^ 只匹配整个字符串开头,而不是每行开头。

热门AI工具

更多
AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

60

2026.10.16

OpenJDK怎么配置Java开发环境
OpenJDK怎么配置Java开发环境

怎样用OpenJDK搭建开发环境?本专题介绍版本选择、下载安装、环境变量配置和编译运行验证,帮助你理清JDK的作用及基本配置流程,并通过简单程序检查环境是否可用,为后续项目开发做好准备。

40

2026.10.16

OpenJDK怎么部署Java应用
OpenJDK怎么部署Java应用

Java项目开发完成后,怎样部署到目标环境并正常运行?本专题介绍OpenJDK应用部署流程,涵盖运行环境准备、版本兼容检查、应用打包、启动参数配置和日志查看,帮助你理清部署前后的操作顺序,减少环境差异造成的运行问题。

40

2026.10.16

Revel框架模板渲染与表单验证
Revel框架模板渲染与表单验证

本专题围绕Revel框架视图层开发,介绍模板语法、变量输出、布局复用、表单提交、参数绑定与验证规则,帮助开发者完成安全规范的页面交互。

20

2026.10.16

Revel框架MVC路由与控制器
Revel框架MVC路由与控制器

本专题聚焦Revel框架MVC核心机制,讲解路由定义、控制器Action、参数绑定、请求响应和反向路由,并结合常见场景梳理接口请求处理流程。

20

2026.10.16

Revel框架入门与安装配置
Revel框架入门与安装配置

本专题从Revel框架环境搭建讲起,系统介绍命令行工具安装、项目创建、目录结构、配置文件及热代码重载,帮助开发者快速完成首个Go Web应用。

20

2026.10.16

Linux 新手先学哪些命令
Linux 新手先学哪些命令

Linux新手命令专题汇集终端基础、文件目录操作、文本查看、软件安装和权限管理等入门文章,帮助按实际任务练习常用命令并建立命令行操作习惯。

40

2026.10.15

MySQL 忘记密码怎么办
MySQL 忘记密码怎么办

MySQL忘记密码专题汇集不同版本与系统下的root密码重置方法,覆盖MySQL 5.7、8.0、Mac、Linux及本地集成环境,并提示恢复权限与重新登录的检查步骤。

40

2026.10.15

Vue.js 中 ref 和 reactive 的区别
Vue.js 中 ref 和 reactive 的区别

Vue.js中ref和reactive的区别专题汇集两种响应式API的定义、访问方式、对象解构、侦听与性能取舍等文章,帮助结合实际状态类型选择合适写法。

20

2026.10.15

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn