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

  • Article

Les extraits de code sont des éléments de code pré-authentifiés prêts à être insérés dans votre application. Vous pouvez augmenter la productivité et la fiabilité à l’aide d’extraits de code pour réduire le temps passé à taper du code répétitif ou à rechercher des exemples.

Cet article fournit une référence au schéma XML de l’extrait de code Visual Studio IntelliSense. Vous pouvez utiliser le schéma pour créer vos propres extraits de code et les ajouter aux extraits de code que Visual Studio inclut déjà.

Assembly, élément

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

La valeur du texte de l’élément Assembly correspond soit au nom convivial de l’assembly, comme System.dll, soit à son nom fort, comme System,Version=1.0.0.1,Culture=neutral,PublicKeyToken=9b35aa323c18d4fb1.

<Assembly>
    AssemblyName
</Assembly>
Élément parent Description
Reference, élément 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.

Author, élément

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

<Author>
   Code Snippet Author
</Author>
Élément parent Description
Header, élément 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 de code

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

Mots clés

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 du document sélectionné à insérer dans l’extrait de code lorsque l’extrait de code est appelé. Par exemple, étant donné un extrait de code qui inclut :

$selected$ is a great color.

Si le mot Blue est sélectionné lorsque l’utilisateur appelle l’extrait de code, le résultat est :

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 apparaît parce qu’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>.

Le code suivant montre la structure de l’élément Code :

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

Une valeur texte est requise. Ce texte spécifie le code, avec les littéraux et les objets, que vous pouvez utiliser quand cet extrait de code est inséré dans un fichier de code.

Attributs

Il existe trois attributs disponibles pour l’élément Code :

  • Langue. Attribut obligatoire qui spécifie la langue de l’extrait de code. La valeur doit être l’une des valeurs suivantes :

    Valeur Description
    VB Extrait de code Visual Basic.
    CSharp Extrait de code C#.
    CPP Extrait de code C++.
    XAML Extrait de code XAML.
    XML Extrait de code XML.
    JavaScript Extrait de code JavaScript.
    TypeScript Extrait de code TypeScript.
    SQL Extrait de code SQL.
    HTML Extrait de code HTML.

  • Kind. Attribut facultatif qui spécifie le type de code que contient l’extrait de code. La valeur doit être l’une des valeurs suivantes :

    Valeur Description
    method body L’extrait de code est un corps de méthode et doit donc être inséré à l’intérieur d’une déclaration de méthode.
    method decl L’extrait de code est une méthode et doit donc être inséré à l’intérieur d’une classe ou d’un module.
    type decl L’extrait de code est un type et doit donc être inséré à l’intérieur d’une classe, d’un module ou d’un espace de noms.
    file L’extrait de code est un fichier de code complet et peut être inséré seul dans un fichier de code ou dans un espace de noms.
    any 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.

  • Délimiteur. Attribut facultatif qui spécifie le délimiteur utilisé pour décrire des littéraux et des objets dans le code. Par défaut, le délimiteur est $.

Élément parent

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

CodeSnippet, élément

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

<CodeSnippet Format="x.x.x">
    <Header>... </Header>
    <Snippet>... </Snippet>
</CodeSnippet>
Attribut Description
Format Attribut obligatoire . Spécifie la version de schéma de l'extrait de code. L’attribut Format doit être une chaîne dans la syntaxe de x.x.x, où chacun x représente une valeur numérique du numéro de version. Visual Studio ignore les extraits de code avec les attributs Format qu’il ne comprend pas.
Élément enfant Description
Header, élément Élément obligatoire . 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, élément Élément obligatoire . Contient le code à insérer par Visual Studio. Il doit y avoir un seul élément Snippet dans un extrait de code.
Élément parent Description
CodeSnippets, élément Élément racine du schéma XML de l'extrait de code.

CodeSnippets, élément

Regroupe des éléments CodeSnippet. 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, élément Élément facultatif. Élément parent pour toutes les données d'extrait de code. Un élément CodeSnippet peut ne contenir aucun élément CodeSnippets ou en contenir plusieurs.

Declarations, é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, élément Élément facultatif. Définit les littéraux de l'extrait de code que vous pouvez modifier. Un élément Literal peut ne contenir aucun élément Declarations ou en contenir plusieurs.
Object, élément Élément facultatif. Définit les objets de l'extrait de code que vous pouvez modifier. Un élément Object peut ne contenir aucun élément Declarations ou en contenir plusieurs.
Élément parent Description
Snippet, élément Contient les références, importations, déclarations et code de l'extrait de code.

Default, élément

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

<Default>
    Default value
</Default>
Élément parent Description
Literal, élément Définit les champs littéraux de l'extrait de code que vous pouvez modifier.
Object, élément 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.

Élément Description

Spécifie des informations descriptives sur le contenu d’un extrait de code.

<Description>
    Code Snippet Description
</Description>
Élément parent Description
Header, élément Contient des informations générales sur l'extrait de code.

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

Function, élément

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

Notes

Certains langages ne prennent pas en charge les éléments Function. Pour savoir quelles fonctions sont disponibles dans un langage déterminé, consultez la documentation correspondante.

<Function>
    FunctionName
</Function>
Élément parent Description
Literal, élément Définit les champs littéraux de l'extrait de code que vous pouvez modifier.
Object, élément 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.

Header, élément

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

<Header>
    <Title>... </Title>
    <Author>... </Author>
    <Description>... </Description>
    <HelpUrl>... </HelpUrl>
    <SnippetTypes>... </SnippetTypes>
    <Keywords>... </Keywords>
    <Shortcut>... </Shortcut>
</Header>
Élément enfant Description
Author, élément É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 Author élément dans un Header élément.
Élément Description Élément facultatif. Description de l'extrait de code. Il peut y avoir zéro ou un Description élément dans un Header élément.
HelpUrl, élément Élément facultatif. URL contenant plus d'informations sur l'extrait de code. Il peut y avoir zéro ou un HelpURL élément dans un Header élément.
Keywords, élément Élément facultatif. Groupe les éléments Keyword. Il peut y avoir zéro ou un Keywords élément dans un Header élément.
Shortcut, élément É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 Shortcut élément dans un Header élément.
SnippetTypes, élément Élément facultatif. Groupe les éléments SnippetType. Il peut y avoir zéro ou un SnippetTypes élément dans un Header élément. S'il n'y a pas d'éléments SnippetTypes, l'extrait de code est toujours valide.
Title, élément Élément obligatoire . Nom convivial de l'extrait de code. Un élément Title doit contenir exactement un élément Header.
Élément parent Description
CodeSnippet, élément É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.

Remarque

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

<HelpUrl>
    www.microsoft.com
</HelpUrl>
Élément parent Description
Header, élément 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 littéraux ou deux objets du même extrait de code ne peuvent pas avoir la même valeur texte dans leurs éléments ID. Les littéraux et les objets ne peuvent pas contenir d’élément ID avec une valeur de end. 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>
Élément parent Description
Literal, élément Définit les champs littéraux de l'extrait de code que vous pouvez modifier.
Object, élément 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.

Import, élément

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

<Import>
    <Namespace>... </Namespace>
</Import>
Élément enfant Description
Namespace, élément Élément obligatoire . Spécifie l'espace de noms utilisé par l'extrait de code. Un élément Namespace doit contenir exactement un élément Import.
Élément parent Description
Imports, élément Élément de regroupement pour les éléments Import.

Imports, élément

Groupe des éléments Import individuels.

<Imports>
    <Import>... </Import>
</Imports>
Élément enfant Description
Import, élément Élément facultatif. Contient les espaces de noms importés pour l'extrait de code. Un élément Imports peut ne contenir aucun élément Import ou en contenir plusieurs.
Élément parent Description
Snippet, élément Contient les références, importations, déclarations et code de l'extrait de code.

Keyword, é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>
Élément parent Description
Keywords, élément Groupe des éléments Keyword individuels.

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

Keywords, é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, élément Élément facultatif. Contient les mots clés de l'extrait de code. Un élément Keyword peut ne contenir aucun élément Keywords ou en contenir plusieurs.
Élément parent Description
Header, élément Contient des informations générales sur l'extrait de code.

Literal, élément

Définit les littéraux de l'extrait de code que vous pouvez modifier. L’élément Literal identifie un remplacement d’un élément de code entièrement contenu dans l’extrait de code qui peut être personnalisé après l’insertion de l’extrait de 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 les objets ne peuvent pas contenir d’élément ID avec une valeur ou selectedend. La valeur $selected$ représente le texte du document sélectionné à insérer dans l’extrait de code lorsque l’extrait de code 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
Modifiable 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, élément Élément obligatoire . Spécifie la valeur par défaut du littéral lorsque vous insérez l'extrait de code. Un élément Default doit contenir exactement un élément Literal.
Function, élément É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 Function élément dans un Literal élément.
ID, élément Élément obligatoire . Spécifie l'identificateur unique du littéral. Un élément ID doit contenir exactement un élément Literal.
ToolTip, élément Élément facultatif. Décrit la valeur attendue et l'utilisation du littéral. Il peut y avoir zéro ou un ToolTip élément dans un Literal élément.
Élément parent Description
Declarations, élément Contient les littéraux et les objets d'un extrait de code que vous pouvez modifier.

Namespace, é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 directive using ou une instruction Imports, s’il n’y figure pas déjà.

<Namespace>
    Namespace
</Namespace>
Élément parent Description
Import, élément 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é.

Object, élément

Définit les objets de l'extrait de code que vous pouvez modifier. L’élément Object identifie un élément requis par l’extrait de code défini 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 nécessitent la spécification d’un type, qui est effectué avec l’élément Type .

<Object Editable="true/false">
    <ID>... </ID>
    <Type>... </Type>
    <ToolTip>... </ToolTip>
    <Default>... </Default>
    <Function>... </Function>
</Object>
Attribut Description
Modifiable 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, élément Élément obligatoire . Spécifie la valeur par défaut du littéral lorsque vous insérez l'extrait de code. Un élément Default doit contenir exactement un élément Literal.
Function, élément É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 Function élément dans un Literal élément.
ID, élément Élément obligatoire . Spécifie l'identificateur unique du littéral. Un élément ID doit contenir exactement un élément Literal.
ToolTip, élément Élément facultatif. Décrit la valeur attendue et l'utilisation du littéral. Il peut y avoir zéro ou un ToolTip élément dans un Literal élément.
Type, élément Élément obligatoire . Spécifie le type de l'objet. Un élément Type doit contenir exactement un élément Object.
Élément parent Description
Declarations, élément Contient les littéraux et les objets d'un extrait de code que vous pouvez modifier.

Reference, élément

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

<Reference>
    <Assembly>... </Assembly>
    <Url>... </Url>
</Reference>
Élément enfant Description
Assembly, élément Élément obligatoire . Spécifie le nom de l'assembly référencé par l'extrait de code. Un élément Assembly doit contenir exactement un élément Reference.
Url, élément É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 Url élément dans un Reference élément.
Élément parent Description
References, élément Élément de regroupement pour les éléments Reference.

References, élément

Groupe des éléments Reference individuels.

<References>
    <Reference>... </Reference>
</References>
Élément enfant Description
Reference, élément Élément facultatif. Contient des informations à propos des références d'assembly de l'extrait de code. Un élément Reference peut ne contenir aucun élément References ou en contenir plusieurs.
Élément parent Description
Snippet, élément Contient les références, importations, déclarations et code de l'extrait de code.

Shortcut, élément

Spécifie le texte de raccourci utilisé pour insérer l'extrait de code. La valeur de texte d’un Shortcut élément ne peut contenir que des caractères alphanumériques et des traits de soulignement (_).

Remarque

Le caractère de soulignement (_) n’est pas pris en charge dans les raccourcis d’extrait de code C++.

<Shortcut>
    Shortcut Text
</Shortcut>
Élément parent Description
Header, élément 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.

Snippet, é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, élément Élément obligatoire . Spécifie le code que vous souhaitez insérer dans un fichier documentation. Un élément Code doit contenir exactement un élément Snippet.
Declarations, élément É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 Declarations élément dans un Snippet élément.
Imports, élément Élément facultatif. Groupe des éléments Import individuels. Il peut y avoir zéro ou un Imports élément dans un Snippet élément.
References, élément Élément facultatif. Groupe des éléments Reference individuels. Il peut y avoir zéro ou un References élément dans un Snippet élément.
Élément parent Description
CodeSnippet, élément Vous permet de spécifier un titre et plusieurs extraits de code que vous pouvez insérer dans des fichiers Visual Studio Code.

SnippetType, élément

Spécifie comment Visual Studio ajoute l’extrait de code.

<SnippetType>
    SurroundsWith/Expansion
</SnippetType>
Élément parent Description
SnippetTypes, élément Groupe les éléments SnippetType.

La valeur doit être l’une des valeurs suivantes :

Valeur Description
Expansion Permet à l’extrait de code d’être inséré au niveau du curseur.
Refactoring Spécifie que l’extrait de code est utilisé pendant la refactorisation C#. Refactoring ne peut pas être utilisé dans les extraits de code personnalisés.
SurroundsWith Permet à l’extrait de code d’être placé autour d’un élément de code sélectionné.

SnippetTypes, élément

Groupe des éléments SnippetType individuels. Si l’élément SnippetTypes n’est pas présent, l’extrait de code peut être inséré au niveau du curseur ou placé autour du code sélectionné.

<SnippetTypes>
    <SnippetType>... </SnippetType>
    <SnippetType>... </SnippetType>
</SnippetTypes>
Élément enfant Description
SnippetType, élément Élément facultatif. Spécifie la manière dont Visual Studio insère l'extrait de code dans le code. Un élément SnippetType peut ne contenir aucun élément SnippetTypes ou en contenir plusieurs.
Élément parent Description
Header, élément Spécifie des informations générales sur l'extrait de code.

Title, é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 le sélecteur d’extraits de code et comme nom de l’extrait de code dans le Gestionnaire des extraits de code.

<Title>
    Code Snippet Title
</Title>
Élément parent Description
Header, élément 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.

ToolTip, élément

Décrit la valeur et l’utilisation attendues d’un littéral ou d’un objet dans un extrait de code. Visual Studio affiche ces informations dans une info-bulle lorsqu’il insère l’extrait de code dans un projet. L’info-bulle s’affiche également lorsque la souris pointe sur le littéral ou l’objet après l’insertion de l’extrait de code.

<ToolTip>
    ToolTip description
</ToolTip>
Élément parent Description
Literal, élément Définit les champs littéraux de l'extrait de code que vous pouvez modifier.
Object, élément 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 identifie un élément requis par l’extrait de code, mais est probablement défini 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 nécessitent la spécification d’un type, qui est effectué avec l’élément Type .

<Type>
    Type
</Type>
Élément parent Description
Object, élément 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. Par exemple :

<Type>System.Data.SqlClient.SqlConnection</Type>

Url, élément

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

Remarque

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

<Url>
    www.microsoft.com
</Url>
Élément parent Description
Reference, élément 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 s’affiche lorsque la référence ne peut pas être ajoutée au projet.

Contenu connexe