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

コードスニペットを使用して生産性と信頼性を向上させ、繰り返しコードの入力やサンプルの検索にかかる時間を短縮できます。コードスニペットは、事前に認証されたコードであり、アプリケーションに挿入する準備ができています。

独自のコードスニペットを作成し、Visual Studio に既に含まれているコードスニペットに追加できます。この記事では、いくつかの手順でコードスニペットを作成する方法について説明します。 XML ファイルを作成し、適切な要素を入力して、ファイルにコードを追加します。必要に応じて、置換パラメーターとプロジェクト参照を使用できます。次に、スニペットを Visual Studio のインストールにインポートします。

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

Visual Studio を開き、[スタート] 画面でコードなしで [続行] を選択します。
メニューバーから [ファイル] >[新しいファイル] を選択するか、Ctrl+N キーを押します。
[ 新しいファイル ] ダイアログボックスで、[ XML ファイル] を選択し、[ 開く] を選択します。

次の基本的なスニペットテンプレートをコードエディターに貼り付けます。

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

スニペットTitle要素にタイトルの平方根を入力します。
Code要素のLanguage属性で、C# スニペットの場合は CSharp、Visual Basic の場合は VB を入力します。

ヒント

使用可能なすべての言語値を確認するには、「コードスニペットスキーマリファレンス」の「属性」を参照してください。
Code要素内の CDATA セクションに次のスニペットコードを追加します。

C# の場合:
```
    <![CDATA[double root = Math.Sqrt(16);]]>
```
Visual Basic の場合:
```
    <![CDATA[Dim root = Math.Sqrt(16)]]>
```
注

コードスニペットの CDATA セクションでは、コード行の書式設定方法やインデント方法を指定することはできません。挿入時に、言語サービスは挿入されたコードを自動的に書式設定します。
スニペットを SquareRoot.snippet として任意の場所に保存します。

コードスニペットをインポートする

スニペットを Visual Studio のインストールにインポートするには、[ツール>コードスニペットマネージャー] を選択するか、Ctrl+K、Bキーを押します。
コードスニペットマネージャーで、[インポート] ボタンを選択します。
コードスニペットの場所に移動して選択し、[ 開く] を選択します。
[ コードスニペットのインポート ] ダイアログボックスで、右側のウィンドウで [ マイコードスニペット ] フォルダーを選択します。終了を選択し、そして OK を選択します。

スニペットは、コード言語に応じて、次のいずれかの場所にコピーされます。
- %USERPROFILE%\Documents\Visual Studio 2022\Code Snippets\Visual C#\My Code Snippets
- %USERPROFILE%\Documents\Visual Studio 2022\Code Snippets\Visual Basic\My Code Snippets
- %USERPROFILE%\Documents\Visual Studio 2019\Code Snippets\Visual C#\My Code Snippets
- %USERPROFILE%\Documents\Visual Studio 2019\Code Snippets\Visual Basic\My Code Snippets
C# または Visual Basic プロジェクトを開いてスニペットをテストします。エディターでコードファイルを開いた状態で、次のいずれかの操作を行います。
- Visual Studio のメニューバーで、編集>IntelliSense>Insert スニペットを選択します。
- 右クリックし、コンテキストメニューから [ スニペット>スニペット の挿入] を選択します。
- キーボードから Ctrl+K、Xキーを押します。
マイコードスニペットを開き、Square Root という名前のスニペットをダブルクリックします。スニペットコードがコードファイルに挿入されます。

説明とショートカットフィールド

[説明] フィールドには、コードスニペットマネージャーで表示されるコードスニペットに関 する詳細情報が表示されます。ショートカットは、スニペットを挿入するために入力できるタグです。

スニペットを編集するには、コード言語に応じて、次のいずれかの場所からスニペットファイルを開きます。
- %USERPROFILE%\Documents\Visual Studio 2022\Code Snippets\Visual C#\My Code Snippets/SquareRoot.snippet
- %USERPROFILE%\Documents\Visual Studio 2022\Code Snippets\Visual Basic\My Code Snippets/SquareRoot.snippet
- %USERPROFILE%\Documents\Visual Studio 2019\Code Snippets\Visual C#\My Code Snippets/SquareRoot.snippet
- %USERPROFILE%\Documents\Visual Studio 2019\Code Snippets\Visual Basic\My Code Snippets/SquareRoot.snippet
ヒント

Visual Studio が配置したディレクトリでファイルを編集しているため、Visual Studio に再インポートする必要はありません。
Author、Description、およびShortcut要素をHeader要素に追加し、入力します。

Header要素が次の例のように見えるのを確認し、ファイルを保存します。

<Header>
    <Title>Square Root</Title>
    <Author>Myself</Author>
    <Description>Calculates the square root of 16.</Description>
    <Shortcut>sqrt</Shortcut>
</Header>

Visual Studio Code スニペットマネージャー を開き、コードスニペットを選択します。右側のウィンドウで、[ 説明]、[ 作成者]、および [ショートカット ] フィールドが設定されていることを確認します。
ショートカットをテストするには、前に使用したプロジェクトを開き、エディターで sqrt と入力し、Visual Basic の 場合は Tab キーを 1 回、C# の場合は 2 回押します。スニペットコードが挿入されます。

置換パラメーター

ユーザーがコードスニペットの一部を置き換える場合があります。たとえば、ユーザーが変数名を現在のプロジェクトの変数名に置き換える場合があります。

リテラルとオブジェクトの 2 種類の置換を指定できます。

Literal 要素を使用して、コードに挿入された後にカスタマイズできるスニペット内に完全に含まれるコードの置換を識別します。たとえば、文字列や数値などです。
Object 要素を使用して、コードスニペットに必要な項目を識別しますが、スニペットの外部で定義されている可能性があります。たとえば、オブジェクトインスタンスやコントロールなどです。

SquareRoot.snippet ファイルのLiteral要素を使用すると、ユーザーが平方根を計算する数値を簡単に変更できます。

SquareRoot.snippet ファイルで、Snippet要素を次のように変更します。

<Snippet>
  <Code Language="CSharp">
    <![CDATA[double root = Math.Sqrt($Number$);]]>
  </Code>
  <Declarations>
    <Literal>
      <ID>Number</ID>
      <ToolTip>Enter the number you want the square root of.</ToolTip>
      <Default>16</Default>
    </Literal>
  </Declarations>
</Snippet>

リテラル置換で ID Numberが取得されていることに注意してください。コードスニペットでその ID を参照するには、次のように $ 文字で囲みます。

<![CDATA[double root = Math.Sqrt($Number$);]]>

スニペットファイルを保存します。
プロジェクトを開き、スニペットを挿入します。

コードスニペットが挿入され、編集可能なリテラルが置換のために強調表示されます。置換パラメーターにカーソルを合わせると、値のヒントが表示されます。

ヒント

スニペットに複数の置換可能なパラメーターがある場合は、 Tab キーを押して、パラメーター間を移動して値を変更できます。

名前空間をインポートする

コードスニペットを使用して、Imports 要素を含めることで、using ディレクティブ (C#) または Imports ステートメント (Visual Basic) を追加できます。 .NET Framework プロジェクトの場合は、 References 要素を使用してプロジェクトへの参照を追加することもできます。

次の XML は、System.IO名前空間にFile.Existsメソッドを使用するコードスニペットを示しています。そのため、System.IO名前空間をインポートするImports要素を定義します。

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>File Exists</Title>
      <Shortcut>exists</Shortcut>
    </Header>
    <Snippet>
      <Code Language="CSharp">
        <![CDATA[var exists = File.Exists("C:\\Temp\\Notes.txt");]]>
      </Code>
      <Imports>
        <Import>
          <Namespace>System.IO</Namespace>
        </Import>
      </Imports>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

Visual Studio IntelliSense コードスニペット XML スキーマリファレンスについては、「コードスニペットスキーマリファレンス」を参照してください。
Visual Studio Code でスニペットを作成するには、「独自のスニペットを作成する」を参照してください。

フィードバック

このページはお役に立ちましたか?

Last updated on 2025-08-15

次の方法で共有

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

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

コード スニペットをインポートする

説明とショートカット フィールド