Sublime Text代码片段可快速插入常用代码结构,需通过Tools→Developer→New Snippet创建XML文件,设置content、tabTrigger、scope和description,并保存至User包目录下以.sublime-snippet结尾,支持占位符、变量及多平台路径。

Sublime Text 的代码片段(Snippet)能帮你快速插入常用代码结构,比如 HTML 标签、函数模板或日志语句。创建和使用都很简单,关键是把逻辑理清、路径放对、语法写准。
一、创建自定义 Snippet 文件
菜单栏依次点击:Tools → Developer → New Snippet…,会打开一个预设 XML 模板。你需要修改几处关键内容:
-
:填你要展开的代码,用 $1、$2表示光标停靠位置(按 Tab 切换),$0是最终光标位 -
:设定触发关键词,比如输入 log再按 Tab 就展开 -
:指定生效范围,如 source.js(JS 文件)、text.html.basic(HTML 文件) -
:可选,描述用途,会在命令面板里显示
举个 JS 控制台日志片段的例子:
二、保存 Snippet 到正确目录
保存时注意文件名必须以 .sublime-snippet 结尾,例如 log.sublime-snippet。默认保存路径是 Sublime 的用户数据目录:
- Windows:
%APPDATA%\Sublime Text\Packages\User\ -
macOS:
~/Library/Application Support/Sublime Text/Packages/User/ - Linux:
~/.config/sublime-text/Packages/User/
存对位置才能被识别。改完不用重启,保存即生效。
三、在编辑器中使用 Snippet
有两种常用方式:
- 在支持的文件类型中,直接输入 tabTrigger(比如
log),然后按 Tab 键,自动展开并定位到第一个占位符 - 按 Ctrl+Shift+P(Win/Linux)或 Cmd+Shift+P(macOS),输入 Insert Snippet,从列表里选择(适合记不清触发词时)
提示:如果没反应,先确认当前文件后缀是否匹配 设置,比如你在 .html 文件里用了 source.js 就不会触发。
四、进阶技巧:变量与环境信息
Snippet 支持内置变量,让代码更智能:
-
$TM_FILENAME:当前文件名 -
$TM_FILEPATH:完整路径 -
$CURRENT_YEAR、$CURRENT_MONTH:自动插入当前日期 -
${1:default}:带默认值的占位符,光标停在这儿,可直接回车跳过或修改
例如写一个带版权头的 JS 片段:
* @author Your Name
* @date $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE
*/
$0]]>
基本上就这些。不复杂但容易忽略 scope 和保存路径,调通一次,后面写代码效率明显不一样。










