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

Article
03/04/2013

Vous pouvez créer un extrait de code avec quelques étapes.Tout ce que vous devez faire est de créer un fichier XML, de remplir les éléments appropriés, puis ajouter le code à celui-ci.Vous pouvez également ajouter des références et des paramètres de remplacement à votre code.Vous pouvez ajouter l'extrait de code dans votre installation Visual Studio à l'aide de le bouton d'importation dans le Gestionnaire des extraits de code (outils/Gestionnaire des extraits de code).

Conseil
Pour plus d'informations sur l'écriture des extraits de code facilement, recherchez le site Web CodePlex pour les outils de la communauté éditeur d'extrait de codetel que.

Modèle d'extrait de code

Voici le modèle de base d'extrait de code :

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets
    xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title></Title>
        </Header>
        <Snippet>
            <Code Language="">
                <![CDATA[]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

Pour créer un extrait de code

Créez un fichier XML dans Visual Studio et ajoutez le modèle ci-dessus.
Remplissez le titre de l'extrait de code, par.. exemple « Hello World » VB, dans l'élément de titre.
Remplissez le langage de l'extrait de code dans l'attribut de langage de l'élément de code.Pour cet exemple, utilisez « VB ».
Ajoutez du code dans la section CDATA à l'intérieur de l'élément de code, par exemple :
```
<Code Language="VB">
    <![CDATA[Console.WriteLine("Hello, World!")]]>
</Code>
```
Enregistrez l'extrait de code comme VBCodeSnippet.snippet.

Pour ajouter un extrait de code dans Visual Studio

Vous pouvez ajouter vos propres extraits de code dans votre installation Visual Studio à l'aide de le Gestionnaire des extraits de code.Ouvrez le Gestionnaire des extraits de code (outils/Gestionnaire des extraits de code).
Cliquez sur le bouton Importer .
Accédez à l'emplacement où vous avez enregistré l'extrait de code dans la procédure précédente, sélectionnez, puis cliquez sur Ouvrir.
La boîte de dialogue Importer un extrait de code s'ouvre, vous demandant de choisir où ajouter l'extrait de code des tableaux dans le volet droit.L'un des choix doit être Mes extraits de code.Sélectionnez-le et cliquez sur Terminer, puis OK.
L'extrait de code est copié dans l'emplacement suivant :

%USERPROFILE%\Documents\Visual Studio 2012\Code Snippets\Visual Basic\My Code Snippets
Testez votre extrait de code en ouvrant un projet Visual Basic et en ouvrant un fichier de code.Dans le menu Insérer un extrait de fichier dans le menu contextuel, puis Mes extraits de code.Vous devez voir un extrait de code nommé Mon extrait de code Visual Basic.Double-cliquez dessus.
Vous devez voir Console.WriteLine("Hello, World!") inséré dans le code.

Ajouter une description et les champs raccourcis

Les champs de description fournissent des informations sur votre extrait de code une fois affichés dans le Gestionnaire des extraits de code.Le raccourci est une balise que les utilisateurs peuvent taper pour insérer l'extrait de code.Modifiez l'extrait de code que vous avez ajouté en ouvrant le fichier %USERPROFILE%\Documents\Visual Studio 2012\Code Snippets\Visual Basic\My Code Snippet\VBCodeSnippet.snippet.
Ajoutez des éléments d'auteur et de description à l'élément d'en-tête, et complétez- les.

L'élément d'en-tête doit ressembler à ceci :

<Header>
    <Title>Hello World VB</Title>
    <Author>Myself</Author>
    <Description>Says Hello to the world.</Description>
</Header>

Ouvrez le Gestionnaire des extraits de code et sélectionnez votre extrait de code.Dans le volet droit vous devez voir que la description et des champs d'auteur sont maintenant remplis.

Pour ajouter un raccourci, ajoutez un élément de raccourci à côté de l'élément d'auteur et de description :

<Header>
    <Title>Hello World VB</Title>
    <Author>Myself</Author>
    <Description>Says Hello to the world.</Description>
    <Shortcut>hello</Shortcut>
</Header>

Enregistrez le fichier d'extrait de nouveau.
Pour tester le raccourci, ouvrez un projet Visual Basic et ouvrez un fichier de code.Tapez hello dans le fichier et appuyez sur TAB.Le code d'extrait de code doit être inséré.

Pour ajouter des références et des importations

Avec les extraits de code Visual Basic vous pouvez ajouter une référence à un projet à l'aide de l'élément de références, puis ajoutez une déclaration d'importations à l'aide de l'élément d'importations.(Les extraits de code dans d'autres langages n'ont pas cette fonctionnalité.) Par exemple, si vous modifiez Console.WriteLine dans l'exemple de code par MessageBox.Show, vous devrez peut-être ajouter l'assembly à System.Windows.Forms.dll au projet.
Ouvrez votre extrait de code.

Ajoutez l'élément de références sous l'élément de l'extrait de code :

<References>
    <Reference>
        <Assembly>System.Windows.Forms.dll</Assembly>
    </Reference>
</References>

Ajoutez l'élément d'importations sous l'élément de l'extrait de code :

<Imports>
    <Import>
       <Namespace>System.Windows.Forms</Namespace>
    </Import>
</Imports>

Modifiez la section CDATA par ce qui suit :

<![CDATA[MessageBox.Show("Hello, World!")]]>

Enregistrez l'extrait de code.
Ouvrez un projet Visual Basic et ajoutez l'extrait de code.
Vous verrez une instruction Imports en haut du fichier de code :
```
Imports System.Windows.Forms
```
Examinez les propriétés du projet.L'onglet de références inclut une référence à System.Windows.Forms.dll.

Ajouter des remplacements

Vous pouvez souhaiter les parties des extraits de code à remplacer par utilisateur, par exemple si vous ajoutez une variable et que l'utilisateur pour remplacer la variable par une dans le projet actuel.Vous pouvez fournir deux types de remplacements : littéraux et objets.Les littéraux sont des chaînes d'un certain type (littéraux de chaîne, noms de variables, ou représentations sous forme de chaîne de valeurs numériques).Les objets sont des instances d'un type autre qu'une chaîne.Dans cette procédure vous déclarerez un remplacement littéral et un remplacement d'objet, puis modifiez le code pour référencer les remplacements.
Ouvrez votre extrait de code.

Cet exemple utilise une chaîne de connexion SQL, vous devez modifier les importations et référencez les éléments pour ajouter les références appropriées :

<References>
    <Reference>
        <Assembly>System.Data.dll</Assembly>
    </Reference>
    <Reference>
        <Assembly>System.Xml.dll</Assembly>
    </Reference>
</References>
<Imports>
    <Import>
        <Namespace>System.Data</Namespace>
    </Import>
    <Import>
        <Namespace>System.Data.SqlClient</Namespace>
    </Import>
</Imports>

Pour déclarer un remplacement littéral pour la chaîne de connexion SQL, ajoutez un élément de déclarations sous l'élément de l'extrait de code, et de lui ajoutez un élément littéral avec des sous-éléments pour l'ID, l'info-bulle, et la valeur par défaut pour le remplacement :
```
<Declarations>
    <Literal>
        <ID>SqlConnString</ID>
        <ToolTip>Replace with a SQL connection string.</ToolTip>
        <Default>"SQL connection string"</Default>
    </Literal>
</Declarations>
```

Pour déclarer un remplacement d'objet pour la connexion SQL, ajouter un élément objet à l'intérieur de l'élément de déclarations, et ajouter des sous-éléments pour l'ID, le type de l'objet, l'info-bulle, et la valeur par défaut.L'élément résultant de déclarations doit ressembler à ceci :

<Declarations>
    <Literal>
        <ID>SqlConnString</ID>
        <ToolTip>Replace with a SQL connection string.</ToolTip>
        <Default>"SQL connection string"</Default>
    </Literal>
    <Object>
        <ID>SqlConnection</ID>
        <Type>System.Data.SqlClient.SqlConnection</Type>
        <ToolTip>Replace with a connection object in your application.</ToolTip>
        <Default>dcConnection</Default>
    </Object>
</Declarations>

Dans la section de code, vous référencez les remplacements à entourer les signes $, par exemple $replacement$:

<Code Language="VB" Kind="method body">
    <![CDATA[Dim daCustomers As SqlDataAdapter
        Dim selectCommand As SqlCommand

        daCustomers = New SqlClient.SqlDataAdapter()
        selectCommand = new SqlClient.SqlCommand($SqlConnString$)
        daCustomers.SelectCommand = selectCommand
        daCustomers.SelectCommand.Connection = $SqlConnection$]]>
</Code>

Enregistrez l'extrait de code.
Ouvrez un projet Visual Basic et ajoutez l'extrait de code.

Le code doit ressembler au suivant, où les remplacements Chaîne de connexion SQL et dcConnection sont mis en surbrillance dans orange-clair.Appuyez sur TAB pour vous déplacer de l'un à l'autre.

Dim daCustomers As SqlDataAdapter
Dim selectCommand As SqlCommand

daCustomers = New SqlClient.SqlDataAdapter()
selectCommand = New SqlClient.SqlCommand("SQL connection string")
daCustomers.SelectCommand = selectCommand
daCustomers.SelectCommand.Connection = dcConnection

Voir aussi

Concepts

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

Partager via