Les extraits de code et comment les utiliser

Les extraits de code sont de petits blocs de code réutilisable que vous pouvez ajouter à un fichier de code. Les extraits contiennent généralement des blocs de code souvent utilisés, tels que des blocs Try...Finally ou If...Else. Vous pouvez également utiliser des extraits de code pour ajouter des classes ou des méthodes entières.

Un extrait de code a un titre que vous utilisez pour le sélectionner, et il peut avoir un nom de raccourci que vous pouvez saisir pour insérer cet extrait de code. Les extraits peuvent aussi contenir des paramètres de remplacement qui agissent comme des espaces réservés. Les extraits sont disponibles dans plusieurs langages, notamment C#, C++ et Visual Basic.

Extraits de code d’extension et extraits de code d’encerclement

Vous pouvez ajouter deux types d’extraits de code à votre code :

• Un extrait d’extension est ajouté à un point d’insertion spécifié.
• Un extrait d’entourage est ajouté autour du code sélectionné et est disponible uniquement pour C# et C++.

Rechercher des extraits disponibles

Pour afficher tous les extraits disponibles dans un langage, sélectionnez Outils>Gestionnaire d’extraits de code dans la barre des menus, ou appuyez sur Ctrl+K, B, puis sélectionnez le langage souhaité dans le menu déroulant.

Pour créer et importer votre propre extrait de code afin qu’il apparaisse dans la liste des extraits de code, consultez Procédure détaillée : Créer un extrait de code dans Visual Studio.

Ajouter un extrait à un fichier de code

Pour ajouter un extrait à un fichier de code :

1. Dans l’éditeur de code, placez votre curseur ou sélectionnez le code C# ou C++ dans lequel vous souhaitez ajouter l’extrait de code.

2. Effectuez l'une des opérations suivantes :

   • Dans la barre des menus de Visual Studio, choisissez Modifier>IntelliSense>Extrait de code d’insertion ou Modifier>IntelliSense>Extrait de code d’entourage.
   • Cliquez avec le bouton droit, puis choisissez Extrait de code>Extrait de code d’insertion ou Extrait de code>Extrait de code d’entourage dans le menu contextuel.
   • Avec le clavier, appuyez sur Ctrl+K, X pour un extrait de code d’extension ou sur Ctrl+K, S pour un extrait de code d’entourage.

3. Double-cliquez sur l’extrait de code souhaité dans la liste déroulante, ou saisissez le raccourci de l’extrait de code, puis appuyez sur Tab ou Entrée.

Ajouter un extrait de code d’extension

Par exemple, l’extrait de code d’extension C# tryf ajoute le bloc Try...Finally suivant :

try
{

}
finally
{

}

Pour ajouter cet extrait de code d’extension :

1. Dans l’éditeur de code, placez votre curseur à l’endroit où vous souhaitez ajouter l’extrait.
2. Cliquez avec le bouton droit et sélectionnez Extrait de code d’insertion dans le menu contextuel, ou utilisez la barre des menus ou les commandes clavier.
3. Ouvrez le dossier Visual C# puis double-cliquez sur tryf dans la liste déroulante, ou sélectionnez tryf puis appuyez sur Tab ou Entrée.

Ajouter un extrait de code d’entourage

Dans l’exemple suivant, qui représente un extrait en C++, le raccourci if peut être utilisé comme un extrait d’insertion ou un extrait d’entourage. Si vous sélectionnez la ligne de code return FALSE; et vous choisissez ensuite Extrait de code d’entourage>if, l’extrait est développé autour de la ligne.

if (true)
{
    return FALSE;
}

Paramètres de remplacement d’extrait de code

Les extraits peuvent contenir des paramètres de remplacement, à savoir des espaces réservés que vous devez remplacer en fonction du code que vous écrivez. Dans l’exemple précédent, true constitue un paramètre de remplacement, auquel se substituera la condition appropriée. Cette condition est répétée pour chaque instance du même paramètre de remplacement dans l’extrait de code.

Par exemple, Visual Basic possède un extrait de code qui définit une propriété. Pour insérer l’extrait :

1. Dans un fichier de code Visual Basic, cliquez avec le bouton droit pour ouvrir le menu contextuel, puis sélectionnez Extrait>Insérer un extrait.
2. Sélectionnez Modèles de code>Propriétés, procédures, événements>Définir une propriété.

Le code suivant est inséré :

Private newPropertyValue As String
Public Property NewProperty() As String
    Get
        Return newPropertyValue
    End Get
    Set(ByVal value As String)
        newPropertyValue = value
    End Set
End Property

Si vous remplacez newPropertyValue par m_property, chaque instance de newPropertyValue est remplacée. Si vous remplacez String par Int dans la déclaration de propriété, la valeur de la méthode Set est également remplacée par Int.

Bonnes pratiques pour l’utilisation des extraits de code

Le code d’un extrait de code montre uniquement le moyen le plus simple de faire quelque chose. Dans la plupart des cas, le code doit être modifié pour s’adapter à l’application,

Gestion des exceptions

En règle générale, les blocs Try...Catch d’extraits de code interceptent et renvoient toutes les exceptions, mais ceci peut ne pas être le bon choix pour votre projet. Pour chaque exception, il existe plusieurs façons de répondre. Vous trouverez des exemples sur les pages Guide pratique pour gérer une exception à l’aide de try/catch (C#) et Instruction Try... Catch... Finally (Visual Basic).

Emplacements des fichiers

Lorsque vous adaptez des emplacements de fichiers à votre application, veillez à prendre en compte les facteurs suivants.

• Trouvez un emplacement accessible. Les utilisateurs peuvent ne pas avoir accès au dossier Fichiers programmes de l’ordinateur. Dans ce cas, il est possible que le stockage de fichiers avec les fichiers d’application ne fonctionne pas.

• Trouvez un emplacement sécurisé. Le stockage des fichiers dans le dossier racine, tel que C:\, n’est pas sécurisé. Pour les données d’application, il est préférable d’utiliser le dossier Données d’application. Pour les données individuelles des utilisateurs, l’application peut créer un fichier dans le dossier Documents de chaque utilisateur.

• Utilisez un nom de fichier valide. Vous pouvez utiliser les contrôles OpenFileDialog et SaveFileDialog pour réduire la probabilité d’avoir des noms de fichiers non valides.

• N’oubliez pas qu’un fichier sélectionné par l’utilisateur peut être supprimé avant que votre code ne puisse manipuler le fichier. En outre, un utilisateur peut ne pas avoir l’autorisation d’écrire dans le fichier.

Sécurité

La sécurité d’un extrait de code dépend de l’endroit où il est utilisé dans le code source et de la façon dont vous le modifiez une fois qu’il se trouve dans le code. La liste suivante contient quelques-uns des points qui doivent être pris en compte :

• Accès aux fichiers et aux bases de données
• Sécurité d'accès du code
• Protection des ressources telles que les journaux des événements et le registre
• Stockage des secrets
• Vérification des entrées
• Transmission des données aux outils de script

Pour plus d’informations, consultez la page Sécuriser des applications.

Extraits de code téléchargés

Les extraits de code installés par Visual Studio ne constituent pas en eux-mêmes un risque de sécurité. Toutefois, ils peuvent entraîner des risques de sécurité dans votre application. Les extraits de code téléchargés sur Internet doivent être traités avec une extrême prudence, comme dans le cas de tout autre contenu téléchargé. Téléchargez des extraits de code uniquement à partir de sites de confiance et utilisez des logiciels antivirus à jour.

Ouvrez tous les fichiers d’extrait de code téléchargés dans le Bloc-notes ou dans l’éditeur XML de Visual Studio, et examinez-les attentivement avant de les installer. Attention aux problèmes suivants :

• L’extrait de code qui est susceptible d’endommager votre système si vous l’exécutez. Lisez le code source attentivement avant de l’exécuter.

• HelpURL bloque les fichiers d’extraits de code contenant des URL qui exécutent des fichiers de script malveillants ou affichent des sites web offensants.

• Les extraits de code contenant des références qui sont ajoutées de manière silencieuse à votre projet et pouvant être chargées à tout endroit de votre système. Vous pourrez télécharger ces références à partir du même emplacement depuis lequel vous téléchargez un extrait de code. L’extrait de code peut ensuite appeler une méthode dans la référence qui exécute du code malveillant. Pour détecter ces références, passez en revue les blocs Imports et References du fichier d’extrait de code.

Contenu connexe

• Procédure détaillée : Créer un extrait de code dans Visual Studio
• Distribuer des extraits de code en tant qu’extension Visual Studio
• Extraits de code C#
• Extraits de code Visual C++
• Référence de schéma des extraits de code