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(自定義代碼片斷)