Snippet 要素 (IntelliSense コード スニペット)

コード スニペットの参照、インポート、宣言、およびコードを指定します。

<Snippet>
    <References>... </References>
    <Imports>... </Imports>
    <Declarations>... </Declarations>
    <Code>... </Code>
</Snippet>

属性および要素

以降のセクションでは、属性、子要素、および親要素について説明します。

属性

なし。

子要素

要素	Description
コード	必須の要素。 ドキュメント ファイルに挿入するコードを指定します。Snippet 要素で使用できる Code 要素は 1 つだけです。
Declarations	省略可能な要素です。 コード スニペットの中で編集可能な部分を表すリテラルおよびオブジェクトを指定します。Snippet 要素に 0 個または 1 個の Declarations 要素があります。
Imports	省略可能な要素です。 複数の Import 要素をグループ化します。Snippet 要素に 0 個または 1 個の Imports 要素があります。
References	省略可能な要素です。 複数の Reference 要素をグループ化します。Snippet 要素に 0 個または 1 個の References 要素があります。

親要素

要素	Description
CodeSnippet	見出しおよび複数の IntelliSense コード スニペットを指定し、Visual Studio のコード ファイルに挿入できます。

使用例

次のコードでは、SqlDataAdapter を作成するための Visual C# コード スニペットを、Snippet 要素と、その子要素を使用して作成しています。

<CodeSnippets xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>Create a data adapter</Title>
            <Description>Creates a SqlDataAdapter object.</Description>
            <Author>Microsoft Corporation</Author>
            <Shortcut>createadapter</Shortcut>
        </Header>
        <Snippet>
            <Declarations>
                <Literal>
                    <ID>SQL</ID>
                    <ToolTip>Replace with a SQL connection string.</ToolTip>
                    <Default>"SQL connection string"</Default>
                </Literal>
                <Object>
                    <ID>Connection</ID>
                    <Type>System.Data.SqlClient.SqlConnection</Type>
                    <ToolTip>Replace with a connection object in your application.</ToolTip>
                    <Default>dcConnection</Default>
                </Object>
            </Declarations>
            <Code Language="CSharp">
                <![CDATA[
                    daCustomers = new SqlClient.SqlDataAdapter();
                    selectCommand = new SqlClient.SqlCommand($SQL$);
                    daCustomers.SelectCommand = selectCommand;
                    daCustomers.SelectCommand.Connection = $Connection$;
                ]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

参照

概念

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