Sublime Text3—Code Snippets(自定义代码片断)

摘要

程序员老是会不断的重复写一些简单的代码片断，为了提升编码效率，咱们能够把常常用到的代码保存起来再调用。

平时用sublime安装各类插件，使用Tab键快速补全，即是snippets（可译为代码片断）的一种。

Sublime编辑器还提供了自定义代码片断的功能（固然不止Sublime有此功能），其官方文档中定义以下：

Whether you are coding or writing the next vampire best-seller, you’re likely to need certain short fragments of text again and again. Use snippets to save yourself tedious typing. Snippets are smart templates that will insert text for you and adapt it to their context.

1、建立snippets

1. 新建和保存

• 菜单栏中依次选择Tools | Developer | New Snippet...就会新建一个扩展名为.sublime-snippet的XML语法的文档，注意后缀是识别snippets的关键。

• 代码片断能够任意存储在packages文件夹下，默认会保存在Packages\User文件夹里，为了方便管理和使用建议再新建个文件夹例如snippets，则路径为Packages\User\snippets。

• 默认结构以下：

<snippet>
    <content><![CDATA[
Hello, ${1:this} is a ${2:snippet}.
]]></content>
    <!-- Optional: Set a tabTrigger to define how to trigger the snippet -->
    <!-- <tabTrigger>hello</tabTrigger> -->
    <!-- Optional: Set a scope to limit where the snippet will trigger -->
    <!-- <scope>source.python</scope> -->
</snippet>复制代码

2. content

• <content></content>中必须包含<![CDATA[…]]>，在这里面写自定义的代码片断。

• 代码片断若是含有]]>，需写成]]$NOT_DEFINED>。

• 若是含有$，需写成\$。

3. tabTrigger

• 在<tabTrigger></tabTrigger>中设置让Sublime自动补全的触发词（trigger keyword）。

4. scope

• 设置代码片断在何种语言环境下激活，默认写的是python。

• 想指定多个scope，可使用英文逗号,来分隔。

• 如何知道文档的Scope是什么？菜单栏依次选择Tools | Developer | Show Scope Name...，快捷键是Ctrl+Alt+Shift+P。

5. description

• 若是加了<description>描述内容</description>，点开Tools | Snippets...会显示你定义的描述内容。

• 若是不写则显示文件名。

6. 设置光标位置Fields

<snippet>
    <content><![CDATA[
First Name: $1
Second Name: $2
Address: $3
]]></content>复制代码

• 美圆符加数字便可设置field markers即光标的位置，按Tab键光标按数字依次从小到大循环，如上从1到2到3再到1。

• Shift+Tab能够进行向上跳转。

• Esc结束跳转。

• $0表示最后一个位置。

7. 镜像域Mirrored Fields

• 相同编号的位置便是镜像域，可同时选中进行编辑。

8. 占位符Placeholders

• {数字编号}能够获得一个Tab占位符。

• {1:default}能够获得一个默认值。

• 按Tab键依次循环选中代码片断中的默认值。

如默认的代码片断Hello, ${1:this} is a ${2:snippet}.会依次循环选中单词this snippet。

2、使用snippets

• 方法1：菜单栏点击Tools | Snippets...,弹出为当前语法可用的Snippet，点击即插入。

• 方法2：输入触发词而后按Tab键。

3、安装snippets

• 方法1：进入Package Control:install Package搜索选择安装已有的代码片断扩展包。

• 方法2：菜单选择Preferences | Browse Packages...打开，建议新建文件夹snippets方便管理，路径为Sublime Text3\Packages\User\snippets，将写好的代码片断拷贝进去。

参考

• sublimetext官方文档Snippets介绍

• 手把手教你写Sublime中的Snippet

• Sublime Text自定制代码片断(Code Snippets)

掘金：Sublime Text3—Code Snippets(自定义代码片断)
简书：Sublime Text3—Code Snippets(自定义代码片断)
博客园：Sublime Text3—Code Snippets(自定义代码片断)