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

Sublime Text怎么设置自动添加头部注释_Sublime Text插件配置【规范】

风伟吖_7694

风伟吖_7694

发布时间:2026-05-20 08:57:29

|

1007人浏览过

|

来源于php中文网

原创

FileHeader插件需手动启用auto_add_to_new_file并配置supported_filetypes、模板文件及变量格式才能生效。必须在Settings-User中设"auto_add_to_new_file": true,添加"supported_filetypes": ["vue","ts","html"],配置对应.tmpl模板和Default变量(如{{author}}),且语法识别正确。

sublime text怎么设置自动添加头部注释_sublime text插件配置【规范】

FileHeader插件必须手动开启 auto_add_to_new_file 才生效

装完 FileHeader 插件后新建文件没反应,不是插件坏了,是默认关着的。它不靠“新建动作”自动触发,只认配置项 auto_add_to_new_file 的布尔值。

打开 Preferences → Package Settings → FileHeader → Settings - User,确保有且仅有一行未被注释的配置:

"auto_add_to_new_file": true

常见错误包括:
• 把这行写在 Settings - Default 里(会被覆盖,且升级后丢失)
• 写了但前面加了 // 或 /* */ 注释掉
• 改完只保存设置,没彻底退出 Sublime Text(macOS 尤其注意:关闭窗口 ≠ 退出进程)
• 新建文件时右下角显示 Plain Text,插件直接跳过(语法未识别)

支持 .vue/.ts/.html 等非默认后缀要配 supported_filetypes + .tmpl 文件

FileHeader 默认只对 .py、.js、.java 等少数后缀生效。想让 .vue 或 .ts 也自动加头,得两步补全:

  • 在 Settings - User 中添加 supported_filetypes,例如:
    "supported_filetypes": ["vue", "ts", "html"]
    (注意:用小写英文名,不是 .vue 或 vue.js)
  • 进 Preferences → Browse Packages… → FileHeader → template → header,确认存在对应 .tmpl 文件:
    • 没有 vue.tmpl 就新建一个
    • 没有 typescript.tmpl 可复制 javascript.tmpl 改名
    • 模板内注释符号必须匹配语言规范(如 HTML 用 <!-- -->,Vue 的 <script> 块用 //)

作者名、日期等变量必须用 {{author}} 且大小写敏感

模板里不能硬写 @Author: 张三,否则无法随项目切换,也不利于团队统一管理。动态内容必须走变量注入:

  • 作者名、邮箱、公司等统一在 Settings - User 的 Default 对象里声明:
    "Default": { "author": "李四", "email": "lisi@team.com" }
  • 模板中对应位置写 {{author}}、{{email}}、{{create_time}}(双大括号,且大小写完全匹配)
    • 错写成 {{Author}} 或 ${author} 都会渲染为空
  • date_format 控制时间格式,例如:
    "date_format": "Y-m-d H:i:s"
    (H 是 24 小时制,h 是 12 小时制;i 是分钟,s 是秒)
  • {{file_name}} 和 {{file_path}} 在文件未保存前返回空字符串,别拿它们做条件判断

保存时自动更新 last_modified_by 需要已有合法头部 + 正确触发

last_modified_by 和 last_modified_time 不是“开箱即用”,它依赖两个前提:

  • 文件已存在合法头部(即开头几行含 /*、#、// 等匹配注释起始符)
  • 保存动作必须落在插件监听范围内——也就是说,文件 syntax 必须正确(右下角不能是 Plain Text),且未被其他插件劫持快捷键或事件

如果改了代码但头部的 Last Modified 没变,先检查是否满足上述两点。另外,FileHeader 的保存时更新逻辑不会覆盖自定义字段(比如你加的 @version),但也不会主动补全——它只管自己认的变量。

热门AI工具

更多
超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

Seko
Seko Hot

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

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

DeepSeek

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

WorkBuddy

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

豆包大模型

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

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

相关专题

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

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

20

2026.10.16

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

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

0

2026.10.16

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

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

0

2026.10.16

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

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

0

2026.10.16

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

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

0

2026.10.16

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

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

20

2026.10.16

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

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

20

2026.10.15

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

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

20

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