翻译自sublime官网doc
Sublime Snippets
Snippets(片段)
无论你在写代码还是下一本畅销书吸血鬼日记，一定会需要一些固定格式的文字。使用Snippets来保存乏味的文字。 Snippets是智能的模板，它会适应上下文并替你插入文本。
创建一个新的片段，选择Tools->Developer->New Snippet... Sublime Text会提供一个框架来创建新的片段
片段可以存储在任意包的文件夹下，但为简单起见，你可以将它们保存在你的Packages/User文件夹下。
Snippets File Format(片段文件格式)
片段通常在一个sublime text包中。它们是简化了的以sublime-snippet为后缀的xml文件。比如，你可以再Email的package中有一个名为greeting.sublime-snippet的片段文件。
典型的片段结构如下(包括Sublime Text为了方便插入的默认提示)：
<snippet>
<content><![CDATA[Type your snippet here]]></content>
<!-- Optional: Tab trigger to activate the snippet -->
<tabTrigger>xyzzy</tabTrigger>
<!-- Optional: Scope the tab trigger will be active in -->
<scope>source.python</scope>
<!-- Optional: Description to show in the menu -->
<description>My Fancy Snippet</description>
</snippet>
snippet元素包含了Sublime Text所需的插入什么，是否插入，何时插入的全部信息，下面依次解释各个元素。
content
content是实际插入的内容，片段可以是简单的模板，也可以是相当复杂的模板，后面我们会讲解这两种模板。
当新建自己的片段时，遵循以下：
- 如果片段中有字符 $，必须使用\转义：$
- 如果片段中包含缩排，使用tabs即可。如果选项
translateTabsToSpaces被设置为true，当片段被插入时tabs会被转换为空格。
片段内容必须使用<![CDATA[...]]包含，否则片段将不会有效
tabTrigger
tabTrigger定义了触发插入片段的键序列。当输入完触发字符并且按Tab键时，片段会立即生效
tab 出发键是隐含的键绑定
scope
范围选择器决定了片段会被激活的上下文，查看Scopes了解更多信息。通常，可以查看当前文档的scope，使用Tools->Develper->Show Scope Name，以下是看看python文件的scope：
文件scope
description
当在Snippets菜单中展示时，会显示片段的描述。如果没有指定描述，Sublime Text会默认展示片段的名字
snippet描述
了解了以上信息，就可以开始编写自己的片段了
Note
为简单起见，我们在例子中只包含了content元素的文本，除非另有说明
Snippet Features (片段特色)
Environment Variables(环境变量)
片段可以通过环境变量的形式访问上下文信息。Sublime Text自动设置以下变量的值。可以添加自定义的变量来提供额外的信息，这些自定义的变量被定义在.sublime-options文件中。
$PARAM1, $PARAM2
|
传递给inset_snippet命令的参数(本文不介绍) |
|---|---|
$SELECTION |
当片段被触发时选中的文本 |
$TM_CURRENT_LINE |
当片段被触发时光标所在行的内容 |
$TM_CURRENT_WORD |
当片段被触发时光标所在单词的内容 |
$TM_FILENAME |
当前被编辑文件的名字，包括扩展名 |
$TM_FILEPATH |
当前被编辑文件路径 |
$TM_FULLNAME |
用户的用户名 |
$TM_LINE_INDEX |
片段被插入的列，列从0开始 |
$TM_LINE_NUMBER |
片段被插入的行，行从1开始 |
$TM_SELECTED_TEXT |
$SELECTION的别名 |
$TM_SOFT_TABS |
当translate_tabs_to_spaces为true时，值为YES,否则为NO
|
$TM_TAB_SIZE |
pre-tab的空格数(由tab_size选项控制) |
以下是使用变量的片段的示例：
====================================
USER NAME: $TM_FULLNAME
FILE NAME: $TM_FILENAME
TAB SIZE: $TM_TAB_SIZE
SOFT TABS: $TM_SOFT_TABS
====================================
# Output:
====================================
USER NAME: guillermo
FILE NAME: test.txt
TAB SIZE: 4
SOFT TABS: YES
====================================
Fields(区段)
使用区段标识，可以通过按tab键的方式在片段中循环选项。当片段被插入时，区段可以用来在片段的定制字段中间跳转。
First Name: $1
Second Name: $2
Address: $3
在上面的例子中，按tab键一次，光标会调到$1的位置，按tab第二次，光标会前进到$2的位置。也可以使用Shift+Tab键回到上一个位置。当高粱的tab停靠位置已经结束，再按tab键Sublime Text会将光标移动到片段结束的位置，以便于回复正常编辑
如果希望控制tab的退出出口，使用$0标识
可以随时使用Esc键退出循环模式
Mirrored Fields(镜像区段)
相同的区段标志彼此反射：当编辑其中一个的时候，其余相同的区段会实时地被相同的值填充。
First Name: $1
Second Name: $2
Address: $3
User name: $1
以上是例子，User name会被与First Name相同的值填充
Place Holders(占位符)
将区段语法做一点点扩展，可以定义区段的默认值。当片段的区段有一个一般情况的值时，使用占位符定义默认值的同时课可以保证区段值自定义的便利性。
First Name: ${1:Guillermo}
Second Name: ${2:López}
Address: ${3:Main Street 1234}
User name: $1
变量可以被使用作为占位符：
First Name: ${1:Guillermo}
Second Name: ${2:López}
Address: ${3:Main Street 1234}
User name: ${4:$TM_FULLNAME}
占位符可以嵌套：
Test: ${1:Nested ${2:Placeholder}}
PS
初次翻译，如有误请见谅 _
网友评论