Snippet, élément (extraits de code IntelliSense)

Article
03/04/2013

Spécifie les références, importations, déclarations et code de l'extrait de code.

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

Attributs et éléments

Les sections suivantes décrivent des attributs, des éléments enfants et des éléments parents.

Attributs

Aucun

Éléments enfants

Élément	Description
Code	Élément requis. Spécifie le code que vous souhaitez insérer dans un fichier documentation.Un élément Snippet doit contenir exactement un élément Code.
Déclarations	Élément facultatif. Spécifie les littéraux et les objets qui composent les parties d'un extrait de code que vous pouvez modifier.Il peut y avoir zéro ou un élément Declarations dans un élément Snippet.
Imports	Élément facultatif. Groupe des éléments Import individuels.Il peut y avoir zéro ou un élément Imports dans un élément Snippet.
Références	Élément facultatif. Groupe les éléments Reference.Il peut y avoir zéro ou un élément References dans un élément Snippet.

Éléments parents

Élément	Description
CodeSnippet	Permet de spécifier un titre et plusieurs extraits de code IntelliSense, que vous pouvez insérer dans des fichiers de code Visual Studio.

Exemple

Le code suivant vous montre comment utiliser l'élément Snippet et ses éléments enfants pour écrire un extrait de code Visual C# qui crée un SqlDataAdapter.

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

Voir aussi

Concepts

Référence de schéma des extraits de code

Partager via