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

Sublime Text FileHeader怎么用_Sublime Text文件头注释教程【经典】

浅丽小哥_7885

浅丽小哥_7885

发布时间:2026-04-11 15:59:27

|

766人浏览过

|

来源于php中文网

原创

FileHeader插件新建文件不自动生成注释,是因为默认关闭自动插入开关;需在Preferences → Package Settings → FileHeader → Settings的User文件中启用"auto_add_to_new_file": true,且确保未被注释、重启编辑器,并确认当前syntax非Plain Text。

sublime text fileheader怎么用_sublime text文件头注释教程【经典】

FileHeader 插件装完没反应,不是插件坏了,是默认关着自动插入开关。 它不靠“新建文件”动作触发,而靠配置项 auto_add_to_new_file 控制;改错位置、没重启、语法识别不对,都会让你以为它失效。

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

打开 Preferences → Package Settings → FileHeader → Settings,确保左侧 User 文件里有这行且**没被注释掉**:

"auto_add_to_new_file": true

常见错误:

  • 把配置写在 Default 文件里(会被升级覆盖)
  • 只改了 User 设置但没重启 Sublime Text
  • 当前文件 syntax 是 Plain Text,插件根本不响应

如果只想对 Python/JS 文件生效,还要在同个 Settings 里加:

"fileheader_custom_template": {
  "supported_filetypes": ["python", "javascript"]
}

supported_filetypes 值必须小写、用英文名(不是 .py 或 js),否则无效。

作者名、时间格式怎么自定义?别碰模板,改变量

模板里写的 ${author}、${date} 不是占位符,是真实变量,值来自 Settings:

  • "author": "Zhang San" —— 改这里比硬编码进模板安全,团队协作时也方便统一
  • "date_format": "Y-m-d H:i:s" —— 注意大小写:H 是 24 小时制,i 是分钟,s 是秒;写成 h:i:s 就会显示 12 小时制
  • ${file_name} 和 ${file_path} 在未保存文件里返回空字符串,别用它们做条件判断

想加中文星期?原生不支持 ${weekday_zh},得换 DocBlockr 或自己写插件扩展。

Ctrl+Alt+T 快捷键没反应?检查作用域和冲突

这个快捷键只在源码视图下生效,比如右下角显示 Python、JavaScript 才管用;在 Markdown、Console 或 Plain Text 里按,完全静默。

  • 进 Preferences → Key Bindings 搜 file_header,看有没有重复或 "disabled": true 的条目
  • 想换快捷键?直接在 User Key Bindings 加一行:{"keys": ["ctrl+shift+h"], "command": "add_file_header"}
  • 性能上几乎无负担,但在未分块的大日志文件(>50MB)里频繁触发,会卡——这是 Sublime 自身限制,不是插件问题

团队项目怎么保证所有人格式一致?别信个人 Settings

单靠每个人改自己的 User Settings,协作时根本保不住格式。Sublime 支持 per-project 配置,优先级高于全局设置。

菜单栏 Project → Edit Project,在 "settings" 下加完整块:

"file_header": {
  "author": "",
  "description_format": "@desc: ${1:description}",
  "license": "MIT"
}

注意:"author": "" 表示强制留空(避免填错名字),但如果设为 null 或删掉这一项,插件会 fallback 到 User Settings,失去约束力。

真正容易被忽略的是:文件头是否插入、插在哪一行、用什么符号包裹,全由当前 syntax scope 决定——不是文件后缀,也不是你心里认定的语言。哪怕你写的是 Python,右下角显示 Plain Text,FileHeader 就不会动一个字。

热门AI工具

更多
LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

WorkBuddy

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

Loomy
Loomy Hot

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

讯飞绘文

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

DeepSeek

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

蛙蛙写作

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

讯飞智作

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

豆包大模型

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

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

相关专题

更多
c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

529

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

1678

2024.03.01

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

1638

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2464

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

5924

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

5249

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

6954

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

9734

2024.04.29

FrankenPHP集成Laravel详细教程
FrankenPHP集成Laravel详细教程

本专题提供FrankenPHP集成Laravel的详细配置指南,全面解析运行原理、开发环境搭建、Caddyfile配置、Octane工作模式、数据库连接、队列任务、定时任务和生产环境优化,解决部署过程中常见的报错与兼容性问题。

0

2026.10.08

热门下载

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

精品课程

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

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