Comment : créer un extrait de code simple

Article
08/21/2008

Mise à jour : novembre 2007

Les extraits de code IntelliSense sont des fichiers XML dotés d'une extension de nom de fichier .snippet qui sont conformes au schéma XML des extraits de code IntelliSense. Dans cette rubrique, vous allez créer un extrait de code de base qui affiche un message. Pour plus d'informations sur le schéma XML des extraits de code, consultez Référence de schéma des extraits de code.

Création d'un fichier .snippet

Avant que vous puissiez commencer à écrire votre extrait de code, vous devez créer un fichier XML avec une extension de nom de fichier .snippet.

Pour créer un fichier .snippet

Dans le menu Fichier, cliquez sur Nouveau, puis sur Fichier.
Cliquez sur Fichier XML, puis sur Ouvrir.
Dans le menu Fichier, cliquez sur Enregistrer <NomFichierXML>.
Dans la zone Type de fichiers, sélectionnez Tous les fichiers (*.*).
Dans la zone Nom de fichier, entrez un nom de fichier avec l'extension .snippet.
Cliquez sur Enregistrer.

Écriture du code

À présent que vous disposez d'un fichier XML, vous devez écrire le code XML qui compose votre extrait de code. Pour plus d'informations sur chacun des éléments XML utilisés dans les exemples suivants, consultez Référence de schéma des extraits de code.

Pour écrire le code pour l'extrait de code

Sous la ligne de code XML générée automatiquement, ajoutez un élément CodeSnippets avec la valeur d'attribut xmlns appropriée, et un élément CodeSnippet pour créer un extrait de code individuel. Par exemple :
```
<CodeSnippets xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
```
Ajoutez une section d'en-tête à l'extrait de code. Par exemple :
```
<Header>
    <Title>
        My Snippet
    </Title>
</Header>
```
Ajoutez les éléments qui définissent l'extrait de code lui-même. Dans l'exemple suivant, le langage de l'extrait de code est Visual Basic.
```
<Snippet>
    <Code Language="VB">

    </Code>
</Snippet>
```
Remarque :

L'attribut Language accepte également les valeurs CSharp, VJSharp et XML. Pour plus d'informations, consultez Code, élément (extraits de code IntelliSense).
À l'intérieur de l'élément Code, ajoutez le code Visual Basic pour l'extrait de code. Tout extrait de code doit être placé entre crochets <![CDATA[ et ]]>. Dans l'exemple suivant, le code qui sera inséré est MessageBox.Show("Hello World").
```
<Code Language="VB">
    <![CDATA[MessageBox.Show("Hello World")]]>
</Code>
```

Remarque :
L'attribut Language accepte également les valeurs CSharp, VJSharp et XML. Pour plus d'informations, consultez Code, élément (extraits de code IntelliSense).

À l'intérieur de l'élément Snippet, ajoutez l'élément References et tous les éléments enfants requis qui ajoutent une référence au projet lorsque l'extrait de code est inséré. Dans cet exemple, l'extrait de code ajoute une référence à System.Windows.Forms.dll lorsque l'extrait de code est inséré.

Remarque :
Seuls les extraits de code Visual Basic prennent en charge la section References. Les extraits de code d'autres langages nécessitent que les références correctes soient ajoutées manuellement.

<Snippet>
    <References>
        <Reference>
            <Assembly>System.Windows.Forms.dll</Assembly>
        </Reference>
    </References>
    <Code Language="VB">
        <![CDATA[MessageBox.Show("Hello World")]]>
    </Code>
</Snippet>

Vous pouvez maintenant utiliser cet extrait de code IntelliSense dans Visual Studio 2005 en suivant les procédures décrites dans Comment : gérer des extraits de code et Comment : insérer des extraits de code IntelliSense.

Exemple

Cet exemple contient l'extrait de code IntelliSense entier créé au cours des étapes précédentes.

<CodeSnippets
    xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>
                My Snippet
            </Title>
        </Header>
        <Snippet>
            <References>
                <Reference>
                    <Assembly>System.Windows.Forms.dll</Assembly>
                </Reference>
            </References>
            <Code Language="VB">
                <![CDATA[MessageBox.Show("Hello World")]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

Cet exemple contient une version Visual C# de l'extrait de code IntelliSense créé au cours des étapes précédentes. Les extraits de code Visual C# ne prennent pas en charge la section References, et une référence à System.Windows.Forms.dll doit donc être ajoutée manuellement au projet.

<CodeSnippets
    xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>
                My Snippet
            </Title>
        </Header>
        <Snippet>
            <Code Language="CSharp">
                <![CDATA[MessageBox.Show("Hello World");]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>