Procédure pas à pas : création d'un extrait de codeWalkthrough: Creating a Code Snippet

Vous pouvez créer un extrait de code en quelques étapes seulement.You can create a code snippet with only a few steps. Il vous suffit de créer un fichier XML, de le remplir avec les éléments appropriés et d’y ajouter votre code.All you need to do is create an XML file, fill in the appropriate elements, and add your code to it. Vous pouvez aussi ajouter des références et des paramètres de remplacement dans votre code.You can also add references and replacement parameters to your code. Vous pouvez ensuite ajouter l’extrait de code à votre installation Visual Studio à l’aide du bouton Importer dans le Gestionnaire des extraits de code (Outils, Gestionnaire des extraits de code...).You can add the snippet to your Visual Studio installation by using the Import button on the Code Snippets Manager (Tools, Code Snippets Manager...).

Modèle d’extrait de codeSnippet Template

Voici le modèle d’extrait de code de base :The following is the basic snippet template:

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets
    xmlns="http://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 codeTo Create a Code Snippet

  1. Créez un fichier XML dans Visual Studio et ajoutez-y le modèle ci-dessus.Create a new XML file in Visual Studio and add the template shown above.

  2. Entrez un titre pour l’extrait de code (par exemple, « Hello World VB ») dans l’élément Title.Fill in the title of the snippet, e.g. "Hello World VB", in the Title element.

  3. Spécifiez le langage de l’extrait de code dans l’attribut Languages de l’élément Code.Fill in the language of the snippet in the Languages attribute of the Code element. Pour cet exemple, entrez « VB ».For this example, use "VB".

  4. Ajoutez du code dans la section CDATA de l’élément Code, par exemple :Add some code in the CDATA section inside the Code element, for example:

    <Code Language="VB">
        <![CDATA[Console.WriteLine("Hello, World!")]]>
    </Code>
    
  5. Enregistrez l’extrait de code sous le nom VBCodeSnippet.snippet.Save the snippet as VBCodeSnippet.snippet.

Pour ajouter un extrait de code dans Visual StudioTo Add a Code Snippet to Visual Studio

  1. Vous pouvez ajouter vos propres extraits de code à votre installation Visual Studio par le biais du Gestionnaire des extraits de code.You can add your own snippets to your Visual Studio installation by using the Code Snippets Manager. Ouvrez le Gestionnaire des extraits de code (Outils, Gestionnaire des extraits de code...).Open the Code Snippets Manager (Tools, Code Snippets Manager...).

  2. Cliquez sur le bouton Importer.Click the Import button.

  3. Accédez à l’emplacement où vous avez enregistré l’extrait de code dans la procédure précédente, sélectionnez-le, puis cliquez sur Ouvrir.Go to the location where you saved the code snippet in the previous procedure, select it, and click Open.

  4. La boîte de dialogue Importer un extrait de code s’ouvre et vous invite à choisir l’emplacement où ajouter l’extrait de code parmi les emplacements proposés dans le volet droit.The Import Code Snippet dialog opens, asking you to choose where to add the snippet from the choices in the right pane. My Code Snippets (Mes extraits de code) est l’une de ces propositions.One of the choices should be My Code Snippets. Sélectionnez-la, puis cliquez sur Terminer, puis sur OK.Select it and click Finish, then OK.

  5. L’extrait de code est copié à l’emplacement suivant :The snippet is copied to the following location:

    %USERPROFILE%\Documents\Visual Studio 2017\Code Snippets\Visual Basic\My Code Snippets%USERPROFILE%\Documents\Visual Studio 2017\Code Snippets\Visual Basic\My Code Snippets

  6. Testez votre extrait de code en ouvrant un projet Visual Basic et un fichier de code.Test your snippet by opening a Visual Basic project and opening a code file. Dans le fichier, choisissez Extraits de code, Insérer un extrait dans le menu contextuel, puis choisissez My Code Snippets.In the file choose Snippets, Insert Snippet from the context menu, then My Code Snippets. Vous devez normalement voir un extrait de code nommé My Visual Basic Code Snippet (Mon extrait de code Visual Basic).You should see a snippet named My Visual Basic Code Snippet. Double-cliquez dessus.Double-click it.

    Console.WriteLine("Hello, World!") est inséré dans le fichier de code.Console.WriteLine("Hello, World!") is inserted in the code file.

Ajout de champs Description et RaccourciAdding Description and Shortcut Fields

  1. Les champs Description donnent des informations supplémentaires sur votre extrait de code affiché dans le Gestionnaire des extraits de code.Description fields give more information about your code snippet when viewed in the Code Snippets Manager. Le raccourci est une balise que les utilisateurs peuvent entrer pour insérer votre extrait de code.The shortcut is a tag that users can type in order to insert your snippet. Pour modifier l’extrait de code que vous avez ajouté, ouvrez le fichier %USERPROFILE%\Documents\Visual Studio 2017\Code Snippets\Visual Basic\My Code Snippet\VBCodeSnippet.snippet.Edit the snippet you have added by opening the file %USERPROFILE%\Documents\Visual Studio 2017\Code Snippets\Visual Basic\My Code Snippet\VBCodeSnippet.snippet.

  2. Ajoutez les éléments Author et Description dans l’élément Header, puis renseignez-les.Add Author and Description elements to the Header element, and fill them in.

  3. L’élément Header doit ressembler à ceci :The Header element should look something like this:

    <Header>
        <Title>Hello World VB</Title>
        <Author>Myself</Author>
        <Description>Says Hello to the world.</Description>
    </Header>
    
  4. Ouvrez le Gestionnaire des extraits de code et sélectionnez votre extrait de code.Open the Code Snippets Manager and select your code snippet. Dans le volet droit, les champs Description et Author doivent maintenant être renseignés.In the right pane you should see that the Description and Author fields are now populated.

  5. Pour ajouter un raccourci, ajoutez un élément Shortcut en dessous des éléments Author et Description :To add a shortcut, add a Shortcut element alongside the Author and Description element:

    <Header>
        <Title>Hello World VB</Title>
        <Author>Myself</Author>
        <Description>Says Hello to the world.</Description>
        <Shortcut>hello</Shortcut>
    </Header>
    
  6. Enregistrez de nouveau le fichier d’extrait de code.Save the snippet file again.

  7. Pour tester le raccourci, ouvrez un projet Visual Basic et un fichier de code.To test the shortcut, open a Visual Basic project and open a code file. Tapez hello dans le fichier et appuyez deux fois sur Tab.Type hello in the file and press Tab twice.

    L’extrait de code est inséré.The snippet code is inserted.

Pour ajouter des références et des importationsTo Add References and Imports

  1. Vous pouvez ajouter une référence à un projet à l’aide de l’élément References et ajouter une déclaration Imports à l’aide de l’élément Imports.You can add a reference to a project by using the References element, and add an Imports declaration by using the Imports element. (Cela s’applique aussi pour C#.) Par exemple, si vous remplacez Console.WriteLine par MessageBox.Show dans l’exemple de code, vous pouvez avoir besoin d’ajouter l’assembly System.Windows.Forms.dll au projet.(This works for C# as well.) For example, if you change Console.WriteLine in the code example to MessageBox.Show, you may need to add the System.Windows.Forms.dll assembly to the project.

  2. Ouvrez votre extrait de code.Open your snippet.

  3. Ajoutez l’élément References sous l’élément Snippet :Add the References element under the Snippet element:

    <References>
        <Reference>
            <Assembly>System.Windows.Forms.dll</Assembly>
        </Reference>
    </References>
    
  4. Ajoutez l’élément Imports sous l’élément Snippet :Add the Imports element under the Snippet element:

    <Imports>
        <Import>
           <Namespace>System.Windows.Forms</Namespace>
        </Import>
    </Imports>
    
  5. Modifiez la section CDATA de la façon suivante :Change the CDATA section to the following:

    <![CDATA[MessageBox.Show("Hello, World!")]]>
    
  6. Enregistrez l’extrait de code.Save the snippet.

  7. Ouvrez un projet Visual Basic et ajoutez l’extrait de code.Open a Visual Basic project and add the snippet.

  8. Il y a maintenant une instruction Imports en haut du fichier de code :You will see an Imports statement at the top of the code file:

    Imports System.Windows.Forms
    
  9. Examinez les propriétés du projet.Look at the project's properties. L’onglet Références affiche une référence à System.Windows.Forms.dll.The References tab includes a reference to System.Windows.Forms.dll.

Ajout de remplacementsAdding Replacements

  1. Vous souhaitez peut-être que certaines parties de votre extrait de code soient remplacées par l’utilisateur, par exemple, si vous ajoutez une variable que l’utilisateur doit remplacer par une valeur dans le projet actuel.You may want parts of your code snippets to be replaced by the user, for example if you add a variable and want the user to replace the variable with one in the current project. Vous pouvez ajouter deux types de remplacements : des littéraux et des objets.You can provide two types of replacements: literals and objects. Les littéraux sont des chaînes d’un type donné (littéraux de chaîne, noms de variable ou représentations sous forme de chaînes de valeurs numériques).Literals are strings of some type (string literals, variable names, or string representations of numeric values). Les objets sont des instances d’un type autre qu’une chaîne.Objects are instances of some type other than a string. Dans cette procédure, vous allez déclarer un remplacement de littéral et un remplacement d’objet, puis modifier le code pour faire référence à ces remplacements.In this procedure you will declare a literal replacement and an object replacement, and change the code to reference these replacements.

  2. Ouvrez votre extrait de code.Open your snippet.

  3. Cet exemple utilise une chaîne de connexion SQL. Vous devez changer les éléments Imports et References pour ajouter les références appropriées :This example uses a SQL connection string, so you need to change the Imports and References elements to add the appropriate references:

    <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>
    
  4. Pour déclarer un remplacement de littéral pour la chaîne de connexion SQL, ajoutez un élément Declarations sous l’élément Snippet et, à l’intérieur du nouvel élément, ajoutez un élément Literal et des sous-éléments pour l’ID, l’info-bulle et la valeur par défaut du remplacement :To declare a literal replacement for the SQL connection string, add a Declarations element under the Snippet element, and in it add a Literal element with subelements for the ID, the tooltip, and the default value for the replacement:

    <Declarations>
        <Literal>
            <ID>SqlConnString</ID>
            <ToolTip>Replace with a SQL connection string.</ToolTip>
            <Default>"SQL connection string"</Default>
        </Literal>
    </Declarations>
    
  5. Pour déclarer un remplacement d’objet pour la connexion SQL, ajoutez un élément Object à l’intérieur de l’élément Declarations et ajoutez des sous-éléments pour l’ID, le type de l’objet, l’info-bulle et la valeur par défaut.To declare an object replacement for the SQL connection, add an Object element inside the Declarations element, and add sub-elements for the ID, the type of the object, the tooltip, and the default value. L’élément Declarations obtenu doit ressembler à ceci :The resulting Declarations element should look like this:

    <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>
    
  6. Dans la section Code, référencez les remplacements en les entourant de signes $, par exemple $replacement$ :In the code section, you reference the replacements with surrounding $ signs, for example $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>
    
  7. Enregistrez l’extrait de code.Save the snippet.

  8. Ouvrez un projet Visual Basic et ajoutez l’extrait de code.Open a Visual Basic project and add the snippet.

  9. Le code doit ressembler à l’exemple ci-dessous, où les remplacements SQL connection string et dcConnection sont indiqués en orange clair.The code should look like the following, where the replacements SQL connection string and dcConnection are highlighted in light orange. Choisissez Tab pour passer de l’un à l’autre.Choose Tab to navigate from one to the other.

    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 aussiSee also