sublime text 3:创建可重复用的代码片段php文件头部注释信息快速生成

http://www.zan3.com/sublime-text-3%E5%88%9B%E5%BB%BA%E5%8F%AF%E5%A4%8D%E7%94%A8%E7%9A%84%E4%BB%A3%E7%A0%81%E7%89%87%E6%AE%B5php%E6%96%87%E4%BB%B6%E5%A4%B4%E9%83%A8%E6%B3%A8%E9%87%8A%E4%BF%A1%E6%81%AF.html

对于程序员来说，每次新建立的页面都要写上备注一大堆重复的代码，为了提高效率，我们就要学会复用代码片段。

创建新代码片段

点击菜单栏里的 Tools 菜单，然后点击 New Snippet… 子菜单，之后会在新的 tab 页创建一个代码片段模板。这个模板主要有3个关键的部分：

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

1.   Hello, ${1:this} is a ${2:snippet} 这正是你要插入到文档中的文本。在此节放入的任何片段都会被插入到你的文档中。

2.   tabTrigger 此节是可选的配置，默认是被注释掉的。默认 hello 的意思是：如果你在某个文档里输入了单词 hello ，然后按下 Tab 键，接着 hello 就会被替换为1中定义的代码片段。再次按下Tab键，接着snippet会被替换为2中定义的代码片段。

3.   scope 此节也是可选配置，默认是被注释掉的。默认 source.php 的意思是：只有在编辑 php 源码的时候，才能用此代码片段。

保存代码片段文件

在能自定义代码片段之前，应该首先保存。在保存文件对话框里，需要明确的指定文件的扩展名为.sublime-snippet，然后把文件保存到默认目录（当前用户主目录下的\Sublime Text 3\Packages\User目录中）。

保存文件之后，就可以测试上面提到的tabTrigger功能了。如果不再使用此功能，可以在此注释掉。

修改代码片段文件

在创建新代码片段中提到过 Hello, ${1:this} is a ${2:snippet} ，其中 ${1:this} 和 ${2:snippet} 是占位符。在插入代码片段后，单词 this 被选中，如果键入内容，this 将会被替换掉，接着按下 Tab 键，将会选中单词 snippet，如果键入内容，snippet 将会被替换掉。

绑定快捷键

可以将上述的操作绑定到一个快捷键，在不键入任何文本的情况下，直接按快捷键插入代码片段。

点击菜单栏的 Preferences 的子菜单 Key Binding – User，在打开的文件的方括号内部粘贴如下配置：

{ “keys”: [“ctrl+1″], “command”: “insert_snippet”, “args”: {“name”: “Packages/User/example.sublime-snippet”} }

现在简单介绍一下这段配置：

1.   “keys”: [“ctrl+1″] 这个定义了触发此命令的快捷键。

2.   “command”: “insert_snippet” 这个是需要触发的命令的名字。

3.   “args”: {“name”: “Packages/User/example.sublime-snippet”} 这个是需要传入到上述命令的参数。这里把代码片段文件的相对路径传递过去。

保存配置文件，现在就可以用快捷键插入代码片段了。

下面是赞生在写的php头部注释片段：

<snippet>
 <content><![CDATA[
<?php
// .-----------------------------------------------------------------------------------
// | Software: [ZAN framework]
// | Version: 2014.1
// | Site: http://www.zancms.com
// |-----------------------------------------------------------------------------------
// | Author: 赞生 <onmichina@gmail.com>
// | Copyright (c) 2012-2014, http://www.zan3.com. All Rights Reserved.
// |-----------------------------------------------------------------------------------
/**
 * web is very nice
 * site www.zan3.com
 * 赞CMS，一个简单的cms
 * @package zan3
 * @author zansheng <onmichina@gmail.com>
 * @time ${1}
 */
// |-----------------------------------------------------------------------------------
${2}
?>
]]></content>
 <!-- Optional: Set a tabTrigger to define how to trigger the snippet -->
 <tabTrigger>php5</tabTrigger>
 <!-- Optional: Set a scope to limit where the snippet will trigger -->
 <!-- <scope>source.python</scope> -->
</snippet>

在我们新建立php文件的时候在文档中，我们输入php5 然后table 键就会在文档中自动输出如下内容：

<?php
// .-----------------------------------------------------------------------------------
// | Software: [ZAN framework]
// | Version: 2014.1
// | Site: http://www.zancms.com
// |-----------------------------------------------------------------------------------
// | Author: 赞生 <onmichina@gmail.com>
// | Copyright (c) 2012-2014, http://www.zan3.com. All Rights Reserved.
// |-----------------------------------------------------------------------------------
/**
 * web is very nice
 * site www.zan3.com
 * 赞CMS，一个简单的cms
 * @package zan3
 * @author zansheng <onmichina@gmail.com>
 * @time 
 */
// |-----------------------------------------------------------------------------------
?>

是不是很方便很效率呢？快点创建自己的代码片段吧！ 一个 神奇的编辑器！