Visual Studio 建立程式碼片段(Snippet code)

Snippet code

在 Visual Studio 中可以將常用的程式碼片段儲存起來，這樣就可以快速的重覆使用。

建立程式碼片段

在Visual Studio中，可以將經常重覆寫的程式碼片段建立起來，利用IntelliSense功能減少重覆撰寫程式碼來增加開發的效率。程式碼片段是以XML格式撰寫，並儲存成 .snippet 副檔名的檔案。建立的步驟如下：

[檔案] -> [新增] -> [檔案] -> 選擇[XML] (如此會開啟一個尚未存檔的xml，檔名為XMLFile1.xml)
[檔案] -> [另存XMLFile1.xml為...] -> 存檔類型請下拉選擇 [Snippet檔案 (*.snippet)] -> 輸入檔名

接下來就可以編輯XML的內容來建立程式碼片段。MSDN上詳細的程式碼片段結構描述參考。

基本的XML檔(C#)

<CodeSnippets
    xmlns="http://schemas.microsoft.com/VisualStudio/2010/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>
        Snippet Demo
      </Title>
    </Header>
    <Snippet>
      <Code Language="CSharp">
        <![CDATA[
        //程式碼片段      
        MessageBox.Show("Hello World~~");
        ]]>
      </Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

Title標籤用來表示此程式碼片段的名稱。

使用 Snippet 檔

建立好的程式碼片段要怎麼用呢？步驟如下：

匯入 snippet
[工具] -> [程式碼片段管理員] -> 選擇語言(C#) -> [匯入] -> 選擇你建立的 snippet 檔 -> 選擇你要存放的位置 -> 確定
使用(在程式碼*.cs檔中使用)
[編輯] -> [插入程式碼片段] (快速鍵為 Ctrl + K, X) -> 選擇你要插入的程式碼目錄(取決於你剛才匯入時存放的位置) -> 撰擇程式碼片段(即Title名稱)

Tips：建議儲存的目錄及片段都以英文命名，如此在選擇程式碼片段時可以完全不用動到滑鼠或切換輸入法。

以下圖為例的鍵盤操作：Ctrl + K, X -> M [Tab] -> S [Tab]

更多的Snippet XML設定

程式碼片段還可以做到預先設定要修改的位置，然後利用Tab鍵來移動到要修改的位置上，讓寫程式碼更快速。例如當你輸入for，然後按兩次Tab鍵，你會看到for迴圈的骨架全部出現，變數的部份則反白，然後就可利用Tab鍵來跳到下一個反白的位置修改。這裡就是要說這個，下面是增加這個功能後的XML：

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets
    xmlns="http://schemas.microsoft.com/VisualStudio/2010/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>
        Snippet Demo
      </Title>
    </Header>
    <Snippet>
      <Declarations>
        <Literal>
          <ID>MSG</ID>
          <Default>Hello World!</Default>
          <ToolTip>要顯示的訊息內容</ToolTip>
        </Literal>
      </Declarations>
      <Code Language="CSharp">
        <![CDATA[
        //程式碼片段
        MessageBox.Show("$MSG$");

        ]]>
      </Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

標籤說明：

Declarations：指定可以編輯的程式碼片段中所含的常值 (Literal) 和物件。子項目為Literal及Object。
Literal：定義常值。子項目為
ID(必要)：識別用。
Default(必要)：預設值。預先填充在可修改的位置。
ToolTip(非必要)：提示文字。滑鼠停留在反白區(Default文字)時顯示的提示文字。

在CDATA中的程式碼，使用 $ID名稱$ 的方式來代表這個ID的Default要出現的位置。

完成後的使用結果如下圖：

記得修改過的Snippet檔要重做第3點，重新匯入一次，才能正常使用。

本文網址：http://blog.tonycube.com/2011/09/visual-studiosnippet.html
由 Tony Blog 撰寫，請勿全文複製，轉載時請註明出處及連結，謝謝 😀