コードスニペット

[アーティクル]
06/10/2015

コードスニペットとは、コード内の必要な場所に挿入できる、再利用可能なコードブロックです。スニペットには、単純なものも、複雑なものもあります。たとえば、try-finally や if-else のようなブロックがよく使用されますが、スニペットを使用してクラス全体またはメソッド全体を挿入することもできます。

挿入スニペットとブロックの挿入用スニペット

Visual Studio では、2 種類のコードスニペットを使用できます。1 つ目は、指定した挿入ポイントに追加される挿入スニペットで、2 つ目は、選択したコードブロックの周囲に追加される、ブロックの挿入用スニペット (C# および C++ のみ) です。

コード内に挿入スニペットを挿入するには、スニペットを挿入する位置にカーソルを置いてショートカットメニューを開き、[スニペットの挿入] をクリックします。次に、目的のスニペットに移動して選択し、Tab キーを押します。スニペットの名前がわかっている場合は、カーソル位置で名前を入力し、Tab キーを 2 回押します。たとえば、次の C# 挿入スニペットを挿入するには、「tryf」と入力して Tab キーを 2 回押すか、[スニペットの挿入] を使用します。

try
{

}
finally
{

}

ブロックの挿入用スニペットを挿入するには、囲む対象のコードを選択してショートカットメニューを開き、[ブロックの挿入] をクリックします。次に、目的のスニペットに移動して選択し、Tab キーを押します。たとえば次の C++ コードを作成するには、「return FALSE」と入力し、それを選択してショートカットメニューを開き、[ブロックの挿入] を選択します。次に、if を選択して Tab キーを押します。

if (true)
{
    return FALSE;
}

[!メモ]

C++ の if スニペットなど、一部のコードスニペットは、挿入スニペットとしてもブロックの挿入用スニペットとしても使用できます。

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

スニペットには、置換パラメーターを含めることができます。置換パラメーターとは、作成中のコードに応じた置換を必要とするプレースホルダーです。前の例で、true は置換パラメーターであり、適切な値への置換が必要です。その値は、スニペット内の置換パラメーターのすべてのインスタンスで繰り返し使用されます。

次の Visual Basic コード例は、プロパティを挿入するための、置換パラメーターが含まれたコードスニペットを示しています (このコードスニペットを挿入するには、ショートカットメニューを開いて [スニペットの挿入]、[コードパターン]、[プロパティ、プロシージャ、イベント] の順にクリックし、[Define a Property] を選択して、Tab キーを押します)。

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

newPropertyValue を m_property に変更すると、newPropertyValue のすべてのインスタンスが変更されます。プロパティ宣言の String を Int に変更すると、set メソッド内の値も変更されます。