Share via

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

  • Article

Les extraits de code IntelliSense sont des parties de code précréées et prêtes à être insérées dans votre application avec Visual Studio. Vous pouvez augmenter la productivité en fournissant des extraits de code qui réduisent le nombre d'heures passées à taper un code répétitif ou à rechercher des exemples. Vous pouvez utiliser le schéma XML des extraits de code IntelliSense pour créer vos propres extraits de code et les ajouter aux extraits de code que Visual Studio contient déjà.

Éléments du schéma des extraits de code IntelliSense

Assembly Element

HelpUrl Element

References Element

Author Element

ID Element

Shortcut Element

Code Element

Import Element

Snippet Element

CodeSnippet Element

Imports Element

SnippetType Element

CodeSnippets Element

Keyword Element

SnippetTypes Element

Declarations Element

Keywords Element

Title Element

Default Element

Literal Element

ToolTip Element

Description Element

Namespace Element

Type Element

Function Element

Object Element

Url Element

Header Element

Reference Element

Assembly, élément

Spécifie le nom de l'assembly référencé par l'extrait de code.

Notes

L'élément Assembly n'est pris en charge que par les extraits de code Visual Basic.

La valeur texte de l'élément Assembly est ou le nom de texte convivial de l'assembly, comme System.dll ou son nom fort, comme System,Version=1.0.0.1,Culture=neutral,PublicKeyToken=9b35aa323c18d4fb1.

<Assembly>
    AssemblyName
</Assembly>

Parent, élément

Description

Reference Element

Contient des informations à propos des références d'assembly requises par l'extrait de code.

Une valeur texte est requise. Ce texte spécifie l'assembly auquel l'extrait de code fait référence.

Auteur, élément

Spécifie le nom de l'auteur de l'extrait de code. Le Gestionnaire des extraits de code affiche le nom d'extrait de code stocké dans l'élément Author de l'extrait de code.

<Author>
   Code Snippet Author
</Author>

Parent, élément

Description

Header Element

Contient des informations générales sur l'extrait de code.

Une valeur texte est requise. Ce texte spécifie l'auteur de l'extrait de code.

Élément Code

Fournit de petits blocs d'extraits de code à un conteneur.

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, étant donné un extrait de code qui inclut :

$selected$ is a great color.

et que le mot « Blue » est sélectionné lorsque l'utilisateur appelle le modèle, le résultat est le suivant :

Blue is a great color.

Vous ne pouvez pas utiliser $end$ ou $selected$ plus d'une fois dans un extrait de code. Si vous le faites, seule la deuxième instance est reconnue. Étant donné un extrait de code qui inclut :

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

si le mot « Blue » est sélectionné, le résultat est le suivant :

 is a great color. I love Blue.

L'espace initial s'affiche car il y a un espace entre $selected$ et is.

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

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

Attribut

Description

Delimiter

Attribut facultatif. Spécifie le délimiteur utilisé pour décrire les littéraux et les objets contenus 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 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.

Language

Attribut requis. Spécifie le langage de l'extrait de code.

Valeur d'attribut, type

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 C#.

CPP

Identifie un extrait de code C++.

XML

Identifie un extrait de code XML.

JavaScript

Identifie un extrait de code JavaScript.

SQL

Identifie un extrait de code SQL.

HTML

Identifie un extrait de code HTML.

Parent, élément

Description

Snippet Element

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

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.

CodeSnippet, élément

Vous permet de spécifier un titre et plusieurs extraits de code IntelliSense que vous pouvez insérer dans des fichiers de code Visual Studio.

<CodeSnippet Format="x.x.x">
    <Header>... </Header>
    <Snippet>... </Snippet>
</CodeSnippet>

Attribut

Description

Format

Attribut requis. Spécifie la version de schéma de l'extrait de code. L'attribut Format doit être une chaîne dont la syntaxe est x.x.x, où chaque "x" représente une valeur numérique du numéro de version. Visual Studio ignore les extraits de code dont il ne comprend pas les attributs Format.

Élément enfant

Description

Header Element

Élément requis. Contient des informations générales sur l'extrait de code. Il doit y avoir un seul élément Header dans un extrait de code.

Snippet Element

Élément requis. Contient le code qui sera inséré par Visual Studio. Il doit y avoir un seul élément Snippet dans un extrait de code.

Parent, élément

Description

CodeSnippets Element

Élément racine du schéma XML de l'extrait de code.

CodeSnippets, élément

Groupe les éléments CodeSnippet Element. L'élément CodeSnippets est l'élément racine du schéma XML de l'extrait de code.

<CodeSnippets>
    <CodeSnippet>... </CodeSnippet>
</CodeSnippets>

Élément enfant

Description

CodeSnippet Element

Élément facultatif. Élément parent pour toutes les données d'extrait de code. Un élément CodeSnippets peut ne contenir aucun élément CodeSnippet ou en contenir plusieurs.

Déclarations, élément

Spécifie les littéraux et les objets qui composent un extrait de code que vous pouvez modifier.

<Declarations>
    <Literal>... </Literal>
    <Object>... </Object>
</Declarations>

Élément enfant

Description

Literal Element

Élément facultatif. Définit les littéraux de l'extrait de code que vous pouvez modifier. Un élément Declarations peut ne contenir aucun élément Literal ou en contenir plusieurs.

Object Element

Élément facultatif. Définit les objets de l'extrait de code que vous pouvez modifier. Un élément Declarations peut ne contenir aucun élément Object ou en contenir plusieurs.

Parent, élément

Description

Snippet Element

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

Par défaut, élément

Spécifie la valeur par défaut du littéral ou de l'objet d'un extrait de code IntelliSense.

<Default>
    Default value
</Default>

Parent, élément

Description

Literal Element

Définit les champs littéraux de l'extrait de code que vous pouvez modifier.

Object Element

Définit les champs objet de l'extrait de code que vous pouvez modifier.

Une valeur texte est requise. Ce texte spécifie la valeur par défaut du littéral ou de l'objet qui remplit les champs de l'extrait de code que vous pouvez modifier.

Description, élément

Spécifie des informations relatives à la description du contenu d'un extrait de code IntelliSense.

<Description>
    Code Snippet Description
</Description>

Parent, élément

Description

Header Element

Contient des informations générales sur l'extrait de code.

Une valeur texte est requise. Ce texte décrit l'extrait de code.

Élément Function

Spécifie une fonction à exécuter lorsque le littéral ou l'objet reçoit le focus dans Visual Studio.

Notes

L'élément Function n'est pris en charge que par les extraits de code Visual C#.

<Function>
    FunctionName
</Function>

Parent, élément

Description

Literal Element

Définit les champs littéraux de l'extrait de code que vous pouvez modifier.

Object Element

Définit les champs objet de l'extrait de code que vous pouvez modifier.

Une valeur texte est requise. Ce texte spécifie une fonction à exécuter lorsque le littéral ou le champ objet reçoit le focus dans Visual Studio.

En-tête, élément

Spécifie des informations d'ordre général sur l'extrait de code IntelliSense.

<Header>
    <Title>... </Title>
    <Author>... </Author>
    <Description>... </Description>
    <HelpUrl>... </HelpUrl>
    <SnippetTypes>... </SnippetTypes>
    <Keywords>... </Keywords>
    <Shortcut>... </Shortcut>
</Header>

Élément enfant

Description

Author Element

Élément facultatif. Nom de la personne ou de la société qui a créé l'extrait de code. Il peut y avoir zéro ou un élément Author dans un élément Header.

Description Element

Élément facultatif. Description de l'extrait de code. Il peut y avoir zéro ou un élément Description dans un élément Header.

HelpUrl Element

Élément facultatif. URL contenant plus d'informations sur l'extrait de code. Il peut y avoir zéro ou un élément HelpURL dans un élément .

Notes

Visual Studio n'utilise pas l'élément HelpUrl.L'élément fait partie du schéma XML des extraits de code IntelliSense et tout extrait de code contenant l'élément est validé mais la valeur de l'élément n'est jamais utilisée.

Keywords Element

Élément facultatif. Groupe les éléments Keyword. Il peut y avoir zéro ou un élément Keywords dans un élément Header.

Shortcut Element

Élément facultatif. Spécifie le texte du raccourci qui peut être utilisé pour insérer l'extrait de code. Il peut y avoir zéro ou un élément Shortcut dans un élément Header.

SnippetTypes Element

Élément facultatif. Groupe les éléments SnippetType. Il peut y avoir zéro ou un élément SnippetTypes dans un élément Header. S'il n'y a pas d'éléments SnippetTypes, l'extrait de code est toujours valide.

Title Element

Élément requis. Nom convivial de l'extrait de code. Un élément Header doit contenir exactement un élément Title.

Parent, élément

Description

CodeSnippet Element

Élément parent pour toutes les données d'extrait de code.

HelpUrl, élément

Spécifie une URL qui fournit des informations supplémentaires sur un extrait de code.

Notes

Visual Studio n'utilise pas l'élément HelpUrl.L'élément fait partie du schéma XML des extraits de code IntelliSense et tout extrait de code contenant l'élément est validé mais la valeur de l'élément n'est jamais utilisée.

<HelpUrl>
    www.microsoft.com
</HelpUrl>

Parent, élément

Description

Header Element

Contient des informations générales sur l'extrait de code.

Une valeur texte est facultative. Ce texte spécifie l'URL à visiter pour plus d'informations sur un extrait de code.

ID, élément

Spécifie l'identificateur unique d'un élément Literal ou Object. Deux objets ou littéraux d'un même extrait de code ne peuvent avoir la même valeur texte dans leurs éléments ID. Les littéraux et objets ne peuvent pas contenir d'élément ID avec une valeur de fin. La valeur $end$ est réservée et utilisée pour marquer l'emplacement du curseur après que l'extrait de code a été inséré.

<ID>
    Unique Identifier
</ID>

Parent, élément

Description

Literal Element

Définit les champs littéraux de l'extrait de code que vous pouvez modifier.

Object Element

Définit les champs objet de l'extrait de code que vous pouvez modifier.

Une valeur texte est requise. Ce texte spécifie l'identificateur unique de l'objet ou du littéral.

Importation, élément

Spécifie les espaces de noms importés et utilisés par un extrait de code IntelliSense.

Notes

L'élément Import est uniquement pris en charge pour les projets Visual Basic.

<Import>
    <Namespace>... </Namespace>
</Import>

Élément enfant

Description

Namespace Element

Élément requis. Spécifie l'espace de noms utilisé par l'extrait de code. Un élément Import doit contenir exactement un élément Namespace.

Parent, élément

Description

Imports Element

Regroupement d'éléments pour les éléments Importation.

Importations, élément

Groupe des éléments Import individuels.

Notes

L'élément Imports est uniquement pris en charge pour les projets Visual Basic.

<Imports>
    <Import>... </Import>
<Imports>

Élément enfant

Description

Import Element

Élément facultatif. Contient les espaces de noms importés pour l'extrait de code. Un élément Importation peut ne contenir aucun élément Imports ou en contenir plusieurs.

Parent, élément

Description

Snippet Element

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

Mot clé, élément

Spécifie un mot clé personnalisé pour l'extrait de code. Les mots clés d'extrait de code sont utilisés par Visual Studio et représentent une manière standard pour les fournisseurs de contenu en ligne d'ajouter des mots clés personnalisés pour les recherches ou la catégorisation.

<Keyword>
    Code Snippet Keyword
</Keyword>

Parent, élément

Description

Keywords Element

Groupe des éléments Keyword individuels.

Une valeur texte est requise. Mot clé pour l'extrait de code.

Mots clés, élément

Groupe des éléments Keyword individuels. Les mots clés d'extrait de code sont utilisés par Visual Studio et représentent une manière standard pour les fournisseurs de contenu en ligne d'ajouter des mots clés personnalisés pour les recherches ou la catégorisation.

<Keywords>
    <Keyword>... </Keyword>
    <Keyword>... </Keyword>
<Keywords>

Élément enfant

Description

Keyword Element

Élément facultatif. Contient les mots clés de l'extrait de code. Un élément Keywords peut ne contenir aucun élément Keyword ou en contenir plusieurs.

Parent, élément

Description

Header Element

Contient des informations générales sur l'extrait de code.

Élément Literal

Définit les littéraux de l'extrait de code que vous pouvez modifier. L'élément Literal est utilisé pour identifier le remplacement d'une partie de code entièrement contenue dans l'extrait de code, mais qui sera probablement personnalisée après avoir été insérée dans le code. Par exemple, les chaînes littérales, les valeurs numériques et certains noms de variables doivent être déclarés comme des littéraux.

Les littéraux et objets ne peuvent pas contenir d'élément ID avec une valeur sélectionnée ou de fin. La valeur $selected$ représente le texte sélectionné dans le document qui sera inséré dans l'extrait de code lorsqu'il est appelé. $end$ marque l'emplacement pour placer le curseur après insertion de l'extrait de code.

<Literal Editable="true/false">
   <ID>... </ID>
   <ToolTip>... </ToolTip>
   <Default>... </Default>
   <Function>... </Function>
</Literal>

Attribut

Description

Editable

Attribut Boolean facultatif. Spécifie si vous pouvez modifier ou non le littéral une fois l'extrait de code inséré. La valeur par défaut de cet attribut est true.

Élément enfant

Description

Default Element

Élément requis. Spécifie la valeur par défaut du littéral lorsque vous insérez l'extrait de code. Un élément Literal doit contenir exactement un élément Default.

Function Element

Élément facultatif. Spécifie une fonction à exécuter lorsque le littéral reçoit le focus dans Visual Studio. Il peut y avoir zéro ou un élément Function dans un élément Literal.

ID Element

Élément requis. Spécifie l'identificateur unique du littéral. Un élément Literal doit contenir exactement un élément ID.

ToolTip Element

Élément facultatif. Décrit la valeur attendue et l'utilisation du littéral. Il peut y avoir zéro ou un élément Info-bulle dans un élément Literal.

Parent, élément

Description

Declarations Element

Contient les littéraux et les objets d'un extrait de code que vous pouvez modifier.

Espace de noms, élément

Spécifie l'espace de noms qui doit être importé pour compiler l'extrait de code et l'exécuter. L'espace de noms spécifié dans l'élément Namespace est ajouté automatiquement au début du code à une instruction Imports, s'il n'y figure pas déjà.

Notes

L'élément Namespace est uniquement pris en charge pour les projets Visual Basic.

<Namespace>
    Namespace
</Namespace>

Parent, élément

Description

Import Element

Importe l'espace de noms spécifié.

Une valeur texte est requise. Ce texte spécifie un espace de noms que l'extrait de code considère comme importé.

Objet, élément

Définit les objets de l'extrait de code que vous pouvez modifier. L'élément Object est utilisé pour identifier un élément qui est requis par l'extrait de code, mais qui est vraisemblablement en dehors de l'extrait de code lui-même. Par exemple, les contrôles Windows Forms, les contrôles ASP.NET, les instances d'objet et les instances de type doivent être déclarées comme objets. Les déclarations d'objet requièrent qu'un type soit spécifié, ce qui est fait avec l'élément Type.

<Object Editable="true/false">
    <ID>... </ID>
    <Type>... </Type>
    <ToolTip>... </ToolTip>
    <Default>... </Default>
    <Function>... </Function>
</Object>

Attribut

Description

Editable

Attribut Boolean facultatif. Spécifie si vous pouvez modifier ou non le littéral une fois l'extrait de code inséré. La valeur par défaut de cet attribut est true.

Élément enfant

Description

Default Element

Élément requis. Spécifie la valeur par défaut du littéral lorsque vous insérez l'extrait de code. Un élément Literal doit contenir exactement un élément Default.

Function Element

Élément facultatif. Spécifie une fonction à exécuter lorsque le littéral reçoit le focus dans Visual Studio. Il peut y avoir zéro ou un élément Function dans un élément Literal.

ID Element

Élément requis. Spécifie l'identificateur unique du littéral. Un élément Literal doit contenir exactement un élément ID.

ToolTip Element

Élément facultatif. Décrit la valeur attendue et l'utilisation du littéral. Il peut y avoir zéro ou un élément Info-bulle dans un élément Literal.

Type Element

Élément requis. Spécifie le type de l'objet. Un élément Object doit contenir exactement un élément Type.

Parent, élément

Description

Declarations Element

Contient les littéraux et les objets d'un extrait de code que vous pouvez modifier.

Référence, élément

Spécifie des informations sur les références d'assembly requises par l'extrait de code.

Notes

L'élément Reference est uniquement pris en charge pour les projets Visual Basic.

<Reference>
    <Assembly>... </Assembly>
    <Url>... </Url>
</Reference>

Élément enfant

Description

Assembly Element

Élément requis. Spécifie le nom de l'assembly référencé par l'extrait de code. Un élément Reference doit contenir exactement un élément Assembly.

Url Element

Élément facultatif. Contient une URL qui fournit plus d'informations sur l'assembly référencé. Il peut y avoir zéro ou un élément Url dans un élément Reference.

Parent, élément

Description

References Element

Élément de regroupement pour les éléments Reference.

Références , élément

Groupe des éléments Reference individuels.

Notes

L'élément References est uniquement pris en charge pour les projets Visual Basic.

<References>
    <Reference>... </Reference>
</References>

Élément enfant

Description

Reference Element

Élément facultatif. Contient des informations à propos des références d'assembly de l'extrait de code. Un élément References peut ne contenir aucun élément Reference ou en contenir plusieurs.

Parent, élément

Description

Snippet Element

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

Raccourci, élément

Spécifie le texte de raccourci utilisé pour insérer l'extrait de code. La valeur texte d'un élément Shortcut peut contenir uniquement des signes alphanumériques, des traits d'union (-) et des traits de soulignement (_).

Avertissement

_ et – ne sont pas des caractères pris en charge dans les raccourcis de l'extrait de code C++.

<Shortcut>
    Shortcut Text
</Shortcut>

Parent, élément

Description

Header Element

Contient des informations générales sur l'extrait de code.

Une valeur texte est facultative. Ce texte est utilisé comme raccourci pour insérer l'extrait de code.

Extrait de code, élément

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

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

Élément enfant

Description

Code Element

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

Declarations Element

Élément facultatif. Spécifie les littéraux et les objets qui composent 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 Element

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

Élément facultatif. Groupe des éléments Reference individuels. Il peut y avoir zéro ou un élément References dans un élément Snippet.

Parent, élément

Description

CodeSnippet Element

Vous permet de spécifier un titre et plusieurs extraits de code IntelliSense que vous pouvez insérer dans des fichiers de code Visual Studio.

Élément SnippetType

Spécifie la manière dont Visual Studio insère l'extrait de code.

<SnippetType>
    SurroundsWith/Expansion
<SnippetType>

Parent, élément

Description

SnippetTypes Element

Groupe les éléments SnippetType.

Le texte doit avoir l'une des valeurs suivantes :

  • SurroundsWith : autorise à placer l'extrait de code autour d'une partie de code sélectionnée.

  • Expansion : autorise à insérer l'extrait de code au curseur.

  • Refactoring : spécifie que l'extrait de code est utilisé pendant la refactorisation Visual C#. Refactoring ne peut pas être utilisé dans les extraits de code personnalisés.

SnippetTypes, élément

Groupe des éléments SnippetType individuels. Si l'élément SnippetTypes est absent, l'extrait de code peut être inséré n'importe où dans le code.

<SnippetTypes>
    <SnippetType>... </SnippetType>
    <SnippetType>... </SnippetType>
<SnippetTypes>

Élément enfant

Description

SnippetType Element

Élément facultatif. Spécifie la manière dont Visual Studio insère l'extrait de code dans le code. Un élément SnippetTypes peut ne contenir aucun élément SnippetType ou en contenir plusieurs.

Parent, élément

Description

Header Element

Spécifie des informations générales sur l'extrait de code.

Titre, élément

Spécifie le titre de l'extrait de code. Le titre stocké dans l'élément Title de l'extrait de code apparaît dans l'Outil d'insertion d'extraits de code ainsi que dans la description de l'extrait de code dans le Gestionnaire des extraits de code.

<Title>
    Code Snippet Title
<Title>

Parent, élément

Description

Header Element

Spécifie des informations générales sur l'extrait de code.

Une valeur texte est requise. Ce texte spécifie le titre de l'extrait de code.

Info-bulle, élément

Décrit la valeur attendue et l'utilisation d'un littéral ou d'un objet d'extrait de code que Visual Studio affiche dans une info-bulle lorsqu'il insère l'extrait de code dans un projet. Le texte d'Info-bulle est affiché lorsque la souris pointe sur le littéral ou sur l'objet après que l'extrait de code a été inséré.

<ToolTip>
    ToolTip description
</ToolTip>

Parent, élément

Description

Literal Element

Définit les champs littéraux de l'extrait de code que vous pouvez modifier.

Object Element

Définit les champs objet de l'extrait de code que vous pouvez modifier.

Une valeur texte est requise. Ce texte spécifie la description de l'info-bulle à associer à l'objet ou au littéral dans l'extrait de code.

Type, élément

Spécifie le type de l'objet. L'élément Object est utilisé pour identifier un élément qui est requis par l'extrait de code, mais qui est vraisemblablement en dehors de l'extrait de code lui-même. Par exemple, les contrôles Windows Forms, les contrôles ASP.NET, les instances d'objet et les instances de type doivent être déclarées comme objets. Les déclarations d'objet requièrent qu'un type soit spécifié, ce qui est fait avec l'élément Type.

<Type>
    Type
</Type>

Parent, élément

Description

Object Element

Définit les champs objet de l'extrait de code que vous pouvez modifier.

Une valeur texte est requise. Ce texte spécifie le type de l'objet.

Url, élément

Spécifie une URL qui fournit des informations supplémentaires sur l'assembly référencé.

Notes

L'élément Url est uniquement pris en charge pour les projets Visual Basic.

<Url>
    www.microsoft.com
</Url>

Parent, élément

Description

Reference Element

Spécifie les références d'assembly requises par l'extrait de code.

Une valeur texte est requise. Ce texte spécifie une URL avec plus d'informations sur l'assembly référencé. Cette URL est affichée lorsque la référence ne peut pas être ajoutée au projet.

Voir aussi

Tâches

Procédure pas à pas : création d'un extrait de code

Autres ressources

Extraits de code