チュートリアル: コード スニペットを作成する

いくつかの手順だけがであるコード スニペットを作成できます。ユーザーがする必要があるのは XML ファイルを作成し、適切な要素を入力し、それにコードを追加するだけです。また、コードへの参照と置換パラメーターを追加できます。Visual Studio のインストールにコード スニペット マネージャー () ツールとコード スニペット マネージャーのインポートのボタンを使用してスニペットを追加できます。

ヒント
コード スニペットをより簡単に作成する方法の詳細については、コミュニティのツールを CodePlex の Web サイト (など) スニペットのエディターを検索します。

スニペットのテンプレート

次は、基本的なスニペットのテンプレートです:

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

コード スニペットを作成するには

1. Visual Studio の新しい XML ファイルを作成し、上記のテンプレートを追加します。

2. スニペットのタイトルをたとえば..、タイトル要素の 「Hello World」 VB の、入力します。

3. コード要素の言語の属性のスニペットの言語を入力します。この例では、「VB」を使用します。

4. コード要素内の CDATA セクションのコードを追加します。例:

   <Code Language="VB">
       <![CDATA[Console.WriteLine("Hello, World!")]]>
   </Code>
   

5. VBCodeSnippet.snippet としてスニペットを保存します。

コード スニペットを Visual Studio に追加するには

1. Visual Studio のインストールにコード スニペット マネージャーを使用して独自のスニペットを追加できます。コード スニペット マネージャー (ツールとコード スニペット マネージャー) を開きます。

2. [インポート] のをクリックします。

3. 前の手順のコード スニペットを保存し、をクリックし、をクリック **[開く]**する位置に移動します。

4. 選択を求めるダイアログが開いて [コード スニペットのインポート] 右ペインの選択範囲からスニペットを追加する場所。選択項目の 1 つが [マイ コード スニペット]必要があります。プロパティを選択し、[完了]、**[OK]**をクリックします。

5. スニペットは次の場所にコピーします:

   %USERPROFILE%\Documents\Visual Studio 2012\Code Snippets\Visual Basic\My Code Snippets

6. Visual Basic プロジェクトを開き、コード ファイルを開くことによって、スニペットをテストします。コンテキスト メニューのをクリック [スニペットの挿入] ファイルに、および [マイ コード スニペット]。My Visual Basic のコード スニペットという名前のスニペットが表示されます。変更をダブルクリックします。

7. コードで挿入 Console.WriteLine("Hello, World!") が表示されます。

説明と切り詰められたフィールドの追加

1. 説明フィールド、コード スニペット マネージャーに表示されると、コード スニペットに関する詳細情報を提供します。ショートカットは、のスニペットを挿入するにユーザーが入力できるタグです。、ファイルの %USERPROFILE%\Documents\Visual Studio 2012\Code Snippets\Visual Basic\My Code Snippet\VBCodeSnippet.snippetの開始して追加したスニペットを編集します。

2. 作成者と説明のヘッダーの要素を要素に追加し、入力します。

3. ヘッダーの要素はこのようなことを確認する必要があります:

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

4. コード スニペット マネージャーを開き、コード スニペットを選択します。右ペインについて、および著者のフィールドが表示されていることを確認してください。

5. ショートカットを追加するには、作成者および description 要素の水平方向のショートカット要素を追加します:

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

6. スニペット ファイルを再度保存します。

7. ショートカットをテストし、Visual Basic のプロジェクトを開いてコード ファイルを開きます。ファイルと入力し、Tab の [ハロー ] を入力します。コード スニペットを挿入する必要があります。

参照とインポートを追加するには

1. Visual Basic スニペットを使用すると参照の要素を使用してプロジェクトへの参照を追加したインポートの要素を使用してインポートの宣言を追加します。(他の言語のスニペットに、この機能はありません)。たとえば、MessageBox.Showのコード例の Console.WriteLine を変更すると、プロジェクトに System.Windows.Forms.dll のアセンブリを追加する必要があります。

2. 独自のスニペットを開きます。

3. スニペットの要素の下で参照の要素を追加します:

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

4. スニペットの要素の下にインポートの要素を追加します:

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

5. 次に、CDATA セクションを変更する:

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

6. スニペットを保存します。

7. Visual Basic プロジェクトを開き、スニペットを追加します。

8. コード ファイルの先頭に Imports ステートメントが表示されます:

   Imports System.Windows.Forms
   

9. プロジェクトのプロパティを参照してください。参照のタブでは、System.Windows.Forms.dll への参照が含まれます。

置換の追加

1. たとえば、変数を追加し、ユーザーに現在のプロジェクトの 1 文字と変数を置換する場合は、コード スニペットのパーツにユーザーに置き換えて必要があります。置換の 2 種類を指定できます: リテラルおよびオブジェクト。リテラルは、型 (リテラル文字列、変数名、数値の文字列形式) の文字列です。オブジェクトは、文字列以外の型のインスタンスです。この手順では、リテラル置換およびオブジェクト置換を宣言し、これらの置換を参照するようにコードを変更します。

2. 独自のスニペットを開きます。

3. この例では、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>
   

4. SQL 接続文字列の文字置換を宣言するには、宣言の要素をスニペットの要素の下に追加し、で置換の ID、ツールヒント、既定のサブ要素の文字の要素を追加します:

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

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

6. コード セクションでは、$ 記号、たとえば $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>
   

7. スニペットを保存します。

8. Visual Basic プロジェクトを開き、スニペットを追加します。

9. コードは次のように置換 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
   

参照

概念

コード スニペット スキーマ リファレンス