逐步解說：建立程式碼片段

發行項
02/28/2013

您可以建立只有少數步驟建立程式碼片段。您需要做的就是建立 XML 檔案，填入適當的項目並在其中加入程式碼。您也可以加入參考和取代參數傳遞給程式碼。您可以將它加入至 Visual Studio 安裝使用在程式碼片段管理員 ([工具/程式碼片段管理員]) 匯入的按鈕。

提示
如需如何撰寫更容易管理程式碼片段的詳細資訊，請搜尋 CodePlex 網站社群等編輯程式碼片段工具。

程式碼片段範本

下列是基本的程式碼片段範本:

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets
    xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title></Title>
        </Header>
        <Snippet>
            <Code Language="">
                <![CDATA[]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

建立程式碼片段

建立新的 XML 檔案無法在 Visual Studio 並將顯示的範本版本。
填入這個程式碼片段的標題，例如.. 「在標題項目的 Hello World VB」，否則為。
填入程式碼片段的語言程式碼項目的語言屬性的。在此範例中，請使用「VB」。
例如將在 CDATA 區段的某個程式碼會在程式碼項目內，如下所示:
```
<Code Language="VB">
    <![CDATA[Console.WriteLine("Hello, World!")]]>
</Code>
```
將這個程式碼片段為 VBCodeSnippet.snippet。

將程式碼片段加入至 Visual Studio

您可以使用程式碼片段管理員，您可以加入擁有片段加入至 Visual Studio 安裝。開啟程式碼片段管理員 ([工具/程式碼片段管理員])。
按一下 [匯入] 按鈕。
移至上一個程序中儲存此程式碼片段，請選取，然後按一下 [[開啟]] 的位置。
[匯入程式碼片段] 對話方塊的位置開啟，要求您選取從右窗格的選擇將這個程式碼片段。其中一個選項應該是 [My Code 程式碼片段]。選取它並按一下 []，然後 [完成][確定]。
這個程式碼片段複製到下列位置:

%USERPROFILE%\Documents\Visual Studio 2012\Code Snippets\Visual Basic\My Code Snippets
藉由在中開啟 Visual Basic 專案並開啟程式碼檔測試這個程式碼片段。在內容功能表上的檔案，然後按一下 [插入程式碼片段][My Code 程式碼片段]。您應該會看到名為 [[我的 Visual Basic 程式碼片段] 的程式碼片段。按兩下 []。
您應該會在程式碼中會插入的 Console.WriteLine("Hello, World!") 。

加入描述和快速鍵的欄位

描述欄位在程式碼片段管理員提供程式碼片段的詳細資訊，請參閱和檢視。快速鍵可讓使用者輸入以插入程式碼片段的標記。編輯您開啟檔案加入 %USERPROFILE%\Documents\Visual Studio 2012\Code Snippets\Visual Basic\My Code Snippet\VBCodeSnippet.snippet的程式碼片段。
將作者和描述項目至標題項目，並將資料填入。

標題項目應該看起來像這樣:

<Header>
    <Title>Hello World VB</Title>
    <Author>Myself</Author>
    <Description>Says Hello to the world.</Description>
</Header>

開啟程式碼片段管理員並選取程式碼片段。在右窗格中您會看到描述和作者欄位會填入 (Populate)。

若要將捷徑，將沿著作者和描述項目的捷徑項目:

<Header>
    <Title>Hello World VB</Title>
    <Author>Myself</Author>
    <Description>Says Hello to the world.</Description>
    <Shortcut>hello</Shortcut>
</Header>

請儲存程式碼片段檔案。
測試捷徑，開啟 Visual Basic 專案並開啟程式碼檔。輸入檔案然後按 TAB 鍵的 Hello 。應該插入程式碼片段。

加入參考和匯入

您可以使用參考項目，您可以使用匯入項目， Visual Basic 程式碼片段可以將參考加入至專案，並加入匯入宣告。(在其他語言中的程式碼片段沒有這項功能)。例如，在中，如果您變更了程式碼範例中的 Console.WriteLine 至 MessageBox.Show，可能需要將 System.Windows.Forms.dll 組件加入至專案。
開啟這個程式碼片段。

將程式碼片段參考項目在項目之下:

<References>
    <Reference>
        <Assembly>System.Windows.Forms.dll</Assembly>
    </Reference>
</References>

加入匯入項目在項目之下的程式碼片段:

<Imports>
    <Import>
       <Namespace>System.Windows.Forms</Namespace>
    </Import>
</Imports>

變更 CDATA 區段變更如下:

<![CDATA[MessageBox.Show("Hello, World!")]]>

將這個程式碼片段。
開啟 Visual Basic 專案並加入這個程式碼片段。
您會看到 Imports 陳述式在程式碼檔的最上方:
```
Imports System.Windows.Forms
```
查看專案的屬性。參考索引標籤加入 System.Windows.Forms.dll 的參考。

將取代

例如，如果您將變數並想要使用者以來取代變數在目前的專案中，您可以將程式碼片段的部分是由使用者所取代。您可以提供取代的兩種類型:常值和物件。常值是陣列型別 (字串常值 (String Literal)、變數名稱或數值字串表示字串)。字串以外，物件都是類別的執行個體。在這個程序中您將宣告為常值取代和物件取代，並變更程式碼參考這些取代。
開啟這個程式碼片段。

這個範例使用 SQL 連接字串，因此，您必須變更匯入和參考項目加上適當的參考:

<References>
    <Reference>
        <Assembly>System.Data.dll</Assembly>
    </Reference>
    <Reference>
        <Assembly>System.Xml.dll</Assembly>
    </Reference>
</References>
<Imports>
    <Import>
        <Namespace>System.Data</Namespace>
    </Import>
    <Import>
        <Namespace>System.Data.SqlClient</Namespace>
    </Import>
</Imports>

若要宣告 SQL 連接字串的常值取代，加入宣告項目在 Snippet 項目下方加入具有子項目的 Literal 項目 ID、工具提示和預設值的取代的:

<Declarations>
    <Literal>
        <ID>SqlConnString</ID>
        <ToolTip>Replace with a SQL connection string.</ToolTip>
        <Default>"SQL connection string"</Default>
    </Literal>
</Declarations>

宣告 SQL 連接的物件取代，將在宣告項目內的物件項目並將 ID、物件的型別，工具提示和預設值的子項目。發生於項目的宣告看起來應該如下所示:

<Declarations>
    <Literal>
        <ID>SqlConnString</ID>
        <ToolTip>Replace with a SQL connection string.</ToolTip>
        <Default>"SQL connection string"</Default>
    </Literal>
    <Object>
        <ID>SqlConnection</ID>
        <Type>System.Data.SqlClient.SqlConnection</Type>
        <ToolTip>Replace with a connection object in your application.</ToolTip>
        <Default>dcConnection</Default>
    </Object>
</Declarations>

在程式碼區段，您使用參考圍繞$符號，例如 $replacement$的取代:

<Code Language="VB" Kind="method body">
    <![CDATA[Dim daCustomers As SqlDataAdapter
        Dim selectCommand As SqlCommand

        daCustomers = New SqlClient.SqlDataAdapter()
        selectCommand = new SqlClient.SqlCommand($SqlConnString$)
        daCustomers.SelectCommand = selectCommand
        daCustomers.SelectCommand.Connection = $SqlConnection$]]>
</Code>

將這個程式碼片段。
開啟 Visual Basic 專案並加入這個程式碼片段。

程式碼應該看起來如下，其中取代 SQL 連接字串和 dcConnection 在淡桔色會反白顯示。按 TAB 鍵從一個移至另一個巡覽。

Dim daCustomers As SqlDataAdapter
Dim selectCommand As SqlCommand

daCustomers = New SqlClient.SqlDataAdapter()
selectCommand = New SqlClient.SqlCommand("SQL connection string")
daCustomers.SelectCommand = selectCommand
daCustomers.SelectCommand.Connection = dcConnection

請參閱

概念

程式碼片段結構描述參考

共用方式為