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.


一、創建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


二、使用snippets

  • 方法1:菜單欄點擊Tools | Snippets...,彈出為當前語法可用的Snippet,點擊即插入。

  • 方法2:輸入觸發詞然后按Tab鍵


三、安裝snippets

  • 方法1:進入Package Control:install Package搜索選擇安裝已有的代碼片段擴展包。

  • 方法2:菜單選擇Preferences | Browse Packages...打開,建議新建文件夾snippets方便管理,路徑為Sublime Text3\Packages\User\snippets,將寫好的代碼片段拷貝進去。


參考


掘金:Sublime Text3—Code Snippets(自定義代碼片段)
簡書:Sublime Text3—Code Snippets(自定義代碼片段)
博客園:Sublime Text3—Code Snippets(自定義代碼片段)

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,967評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,273評論 3 415
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,870評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,742評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,527評論 6 407
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,010評論 1 322
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,108評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,250評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,769評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,656評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,853評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,371評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,103評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,472評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,717評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,487評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,815評論 2 372