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

Article
08/10/2011

Fournit un conteneur aux petits blocs d'extraits de code Intellisense.

<Code Language="Language"
    Kind="method body/method decl/type decl/page/file/any"
    Delimiter="Delimiter">
    Code to insert
</Code>

Attributs et éléments

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

Attributs

Attribut	Description
Delimiter	Attribut facultatif. Spécifie le séparateur utilisé pour décrire les littéraux et les objets dans le code. Par défaut, le délimiteur est $.
Kind	Attribut facultatif. Spécifie le type de code que l'extrait de code contient et, par conséquent, l'emplacement auquel un extrait de code doit être inséré pour que l'extrait de code puisse être compilé. Les valeurs disponibles sont method body, method decl, type decl, file et any. Pour plus d'informations, consultez la section « Attribut Kind » dans le tableau suivant.
Language	Attribut requis. Spécifie le langage de l'extrait de code. Les valeurs disponibles sont VB, CSharp ou XML. Pour plus d'informations, consultez la section « Attribut Language » dans le tableau suivant. RemarqueLe schéma Extrait de code Intellisense ne prend pas en charge C++.

Delimiter

Attribut facultatif.

Spécifie le séparateur utilisé pour décrire les littéraux et les objets dans le code. Par défaut, le délimiteur est $.

Kind

Attribut facultatif.

Spécifie le type de code que l'extrait de code contient et, par conséquent, l'emplacement auquel un extrait de code doit être inséré pour que l'extrait de code puisse être compilé. Les valeurs disponibles sont method body, method decl, type decl, file et any. Pour plus d'informations, consultez la section « Attribut Kind » dans le tableau suivant.

Language

Attribut requis.

Spécifie le langage de l'extrait de code. Les valeurs disponibles sont VB, CSharp ou XML. Pour plus d'informations, consultez la section « Attribut Language » dans le tableau suivant.

RemarqueLe schéma Extrait de code Intellisense ne prend pas en charge C++.

Attribut Kind

Valeur	Description
method body	Spécifie que l'extrait de code est un corps de méthode, et par conséquent, qu'il doit être inséré à l'intérieur d'une déclaration de méthode.
method decl	Spécifie que l'extrait de code est une méthode, et par conséquent, qu'il doit être inséré à l'intérieur d'une classe ou d'un module.
type decl	Spécifie que l'extrait de code est un type, et par conséquent, qu'il doit être inséré à l'intérieur d'une classe, d'un module ou d'un espace de noms.
file	Spécifie que l'extrait de code est un fichier de code complet. Ces extraits de code peuvent être insérés seuls dans un fichier de code, ou à l'intérieur d'un espace de noms.
any	Spécifie que l'extrait de code peut être inséré n'importe où. Cette balise est utilisée pour les extraits de code indépendants du contexte, comme les commentaires.

Attribut Language

Valeur	Description
VB	Identifie un extrait de code Visual Basic.
CSharp	Identifie un extrait de code Visual C#.
XML	Identifie un extrait de code XML.

Éléments enfants

Aucun

Éléments parents

Élément	Description
Snippet	Contient les références, importations, déclarations et code de l'extrait de code.

Valeur texte

Une valeur texte est requise.

Ce texte spécifie le code, avec les littéraux et les objets, que vous pouvez utiliser lorsque cet extrait de code est inséré dans un projet.

Notes

Deux mots réservés peuvent être utilisés dans le texte de l'élément Code : $end$ et $selected$. $end$ marque l'emplacement pour placer le curseur après insertion de l'extrait de code. $selected$ représente le texte sélectionné dans le document qui sera inséré dans l'extrait de code lorsqu'il est appelé Par exemple, si vous avez :

$selected$ is a great color. I love $selected$.

et que le mot "Blue" a été sélectionné lorsque vous avez appelé le modèle, vous obtenez :

Blue is a great color. I love Blue.

Tous les autres mots clés $ sont définis dynamiquement dans les balises <Literal> et <Object>.

Exemple

L'élément Code de l'extrait de code suivant montre comment écrire un extrait de code Visual C# qui crée un SqlDataAdapter. Le littéral et l'objet définis dans l'élément Declarations sont référencés dans l'élément Code par la valeur de leur élément ID. Dans cet exemple, le littéral est référencé comme $SQL$ et l'objet est référencé comme $Connection$.

<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