コード スニペットCode Snippets

コードスニペットは、コンテキスト メニュー コマンドまたはホット キーの組み合わせを使用してコード ファイルに挿入できる、再利用可能なコードの小さなブロックです。Code snippets are small blocks of reusable code that can be inserted in a code file using a context menu command or a combination of hotkeys. 通常、スニペットには try-finally または if-else などよく使用されるコード ブロックが含まれていますが、スニペットを使用してクラス全体またはメソッド全体を挿入することもできます。They typically contain commonly-used code blocks such as try-finally or if-else blocks, but they can be used to insert entire classes or methods.

拡張スニペットとブロックの挿入用スニペットExpansion Snippets and Surround-With Snippets

Visual Studio には、2 種類のコード スニペットがあります。1 つ目は、指定した挿入ポイントに追加され、スニペット ショートカットを置換できる拡張スニペットで、2 つ目は、選択したコード ブロックの周囲に追加される、ブロックの挿入用スニペット (C# および C++ のみ) です。In Visual Studio there are two kinds of code snippet: expansion snippets, which are added at a specified insertion point and may replace a snippet shortcut, and surround-with snippets (C# and C++ only), which are added around a selected block of code.

挿入スニペットの例: C# では、ショートカット tryf は try-finally ブロックの挿入に使用されます。An example of an insertion snippet: in C# the shortcut tryf is used to insert a try-finally block:

try  
{  

}  
finally  
{  

}  

このスニペットを挿入するには、コード ウィンドウのコンテキスト メニューで [スニペットの挿入] をクリックしてから、[Visual C#] をクリックし、「tryf」と入力して、Tab キーを押します。または、「tryf」と入力して Tab キーを押し、もう一度 Tab キーを押します。You can insert this snippet by clicking Insert Snippet in the context menu of the code window, then Visual C#, then type tryf, then TAB, or you can type tryf and press TAB + TAB.

ブロックの挿入用スニペットの例: C++ では、ショートカット if は挿入スニペットまたはブロックの挿入用スニペットとして使用できます。An example of a surround-with snippet: in C++ the shortcut if can be used either as an insertion snippet or as a surround-with snippet. コード行 (例: return FALSE;) を選択し、[ブロックの挿入][if] をクリックすると、行の周りにスニペットが展開されます。If you select a line of code (for example return FALSE;), and then click Surround With, then if, the snippet is expanded around the line:

if (true)  
{  
    return FALSE;  
}  

スニペットの置換パラメーターSnippet Replacement Parameters

スニペットには置換パラメーターを含めることができます。置換パラメーターとは、作成中の実際のコードに応じた置換を必要とするプレースホルダーです。Snippets can contain replacement parameters, which are placeholders that you must replace to fit the precise code you are writing. 前の例で、true は置換パラメーターであり、適切な条件への置換が必要です。In the previous example true is a replacement parameter, which you would replace with the appropriate condition. 置換を行うと、スニペット内の同じ置換パラメーターのすべてのインスタンスでもこれが繰り返されます。The replacement you make is repeated for every instance of the same replacement parameter in the snippet.

たとえば、Visual Basic には、プロパティを挿入するコード スニペットがあります。For example, in Visual Basic there is a code snippet that inserts a property. コード ウィンドウのコンテキスト メニューで [スニペットの挿入] をクリックし、[コード パターン][プロパティ、プロシージャ、イベント]、[プロパティの定義] の順にクリックします。Click Insert Snippet on the context menu of the code window, then Code Patterns, then Properties, Procedures, Events, then Define a property. 次のコードが挿入されます。The following code is inserted:

Private newPropertyValue As String  
Public Property NewProperty() As String  
    Get  
        Return newPropertyValue  
    End Get  
    Set(ByVal value As String)  
        newPropertyValue = value  
    End Set  
End Property  

newPropertyValuem_property に変更すると、newPropertyValue のすべてのインスタンスが変更されます。If you change newPropertyValue to m_property, then every instance of newPropertyValue is changed. プロパティ宣言の StringInt に変更すると、set メソッド内の値も Int に変更されます。If you change String to Int in the property declaration, then the value in the set method is also changed to Int.

コード スニペット マネージャーCode Snippet Manager

現在インストールされているコード スニペットと、ディスク上の場所に関する情報を表示するには、[ツール/コード スニペット マネージャー] をクリックします。You can see all the code snippets that are currently installed, plus their location on disk, by clicking Tools/Code Snippets Manager. スニペットが言語別に表示されます。Snippets are displayed by language.

[コード スニペット マネージャー] ダイアログの [追加][削除] ボタンを使用して、スニペット ディレクトリを追加および削除することができます。You can add and remove snippet directories with the Add and Remove buttons in the Code Snippets Manager dialog. 個々のコード スニペットを追加するには、[インポート] ボタンを使用します。To add individual code snippets, use the Import button.

関連項目See Also

チュートリアル: コード スニペットを作成する Walkthrough: Creating a Code Snippet
方法: コード スニペットを配布する How to: Distribute Code Snippets
コード スニペットを使用するためのベスト プラクティス Best Practices for Using Code Snippets
スニペットのトラブルシューティング Troubleshooting Snippets
Visual C# のコード スニペット Visual C# Code Snippets
Visual C++ のコード スニペット Visual C++ Code Snippets
コード スニペット スキーマ リファレンスCode Snippets Schema Reference