Hello welcome to Yzone.net

Sublime Text Snippets(代码片段)

我们在编写代码的时候,总会遇到一些需要反复使用的代码片段。这时候就需要反复的复制和黏贴,大大影响效率。我们利用Sublime Text的snippet功能,就能很好的解决这一问题。通俗的讲,就是把我们常用的代码分别保存起啦,然后通过插件的形式来反复调用。

创建方法:Tools > New Snippet (Mac下在Tools > Developer > New Snippet ...)

这时你会看到如下示例代码:

<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>

说明

此时的你应该有点莫名,我们接着来看下完整的结构和说明:

<snippet>
    <content><![CDATA[ 你需要插入的代码片段${1:name} ]]></content>
    <!-- 可选:快捷键,利用Tab自动补全代码的功能 -->
    <tabTrigger>xyzzy</tabTrigger>
    <!-- 可选:使用范围,不填写代表对所有文件有效。附:source.css和test.html分别对应不同文件。 -->
    <scope>source.python</scope>
    <!-- 可选:在snippet菜单中的显示说明(支持中文)。如果不定义,菜单则显示当前文件的文件名。 -->
    <description>My Fancy Snippet</description>
</snippet>
  • ${1:name}表示代码插入后,光标所停留的位置,可同时插入多个。其中:name为自定义参数(可选)。
  • ${2}表示代码插入后,按Tab键,光标会根据顺序跳转到相应位置(以此类推)。

想指定多个scope,可以使用英文逗号“,”来分隔。Window版Sublime Text查看文件的scope类型,使用 Ctrl+Shift+Alt+P 快捷键,scope类型会显示在编辑器左下角,多个scope类型的文件我们只需要取第一个即可。 Mac 版 Sublime快捷键是Ctrl+Alt+P 查看文件的scope类型

示例

现在,你应该有了个大致的了解。那我们就开始自己动手编写一个实例:

<snippet>
     <content>
     <![CDATA[
     <footer>
          <p>Copyright © 2008-2012 ${1:bluesdream}.com</p>
          <p>增值电信业务经营许可证 沪B2-${2} <a href="#">沪ICP备号${3}</a></p>
     </footer>
     ]]>
     </content>
     <tabTrigger>cft</tabTrigger>
     <description>custom-footer</description>
     <scope>text.html</scope>
</snippet>

创建完毕以后,保存在Packages/User目录下,文件命名为cft-code (随意,直观明了最好),后缀名.sublime-snippet

需要注意的是,文件名必须以 .sublime-snippet 为扩展名,否则Sublime Text将不能识别它是一个代码片段。

此时我们打开一个html文件,输入cft,再按Tab键,刚才我们所编写的代码段,就插入了进来。并且此时的光标停留在我们所标记的${1}位置处,如果我们再按下Tab,那么光标就跳转到${2}的位置。由于我们在scope中定义了仅在html文件中使用,所以此时如果我们打开的是css或其他格式的文件,那将无法插入代码段。

补充: - 除了利用快捷键Tab出代码之外,我们还能通过菜单来加载,打开Tools > Snippet,选择Snippet: custom-footer。如果你没有定义description,那此时便会看到以我们文件名为命名的Snippet: cft-code选项。 - 按Ctrl+Shift+p (Mac下Command+Shift+p)然后在输入 snippet 也可以插入相应的片段

更多说明可查看:帮助文档(英)

转自:蓝色梦想


分类 tool    标签 sublime , tool , software
文档结构