Extraits de code et comment les utiliser

2025-06-12

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

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

Extraits de code d’extension et extraits d’environnement

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

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

Rechercher des extraits de code disponibles

Pour afficher les extraits de code disponibles pour une langue , sélectionnez>Le Gestionnaire d’extraits de code d’outils dans la barre de menus, ou appuyez sur Ctrl+K, B, puis sélectionnez la langue souhaitée dans le menu déroulant.

Capture d’écran de la boîte de dialogue Gestionnaire d’extraits de code.

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

Ajouter un extrait de code à un fichier de code

Pour ajouter un extrait de code à un fichier de code :

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.
Effectuez l'une des opérations suivantes :
- Dans la barre de menus de Visual Studio, choisissez Modifier>IntelliSense>Insérer un extrait de code ou Modifier>IntelliSense>Entourer avec.
- Cliquez avec le bouton droit, puis choisissez Extrait>Insérer Extrait ou Extrait>Entourer avec à partir du menu contextuel.
- Depuis le clavier, appuyez sur Ctrl+K, X pour un fragment d'expansion ou Ctrl+K, S pour un fragment d'encadrement.
Double-cliquez sur l’extrait de code souhaité dans la liste déroulante, ou tapez 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 tryf d’extension C# ajoute le bloc suivant Try...Finally :

try
{

}
finally
{

}

Pour ajouter cet extrait de code d’extension :

Dans l’éditeur de code, positionnez votre curseur dans lequel vous souhaitez ajouter l’extrait de code.
Cliquez avec le bouton droit et sélectionnez Insérer un extrait dans le menu contextuel, ou utilisez la barre de menus ou les commandes clavier.
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.

Conseil / Astuce

Vous pouvez également placer votre curseur au point d’insertion, taper tryf, puis appuyer deux fois sur Tab .

Ajouter un extrait de code d’entourement

Dans l’exemple suivant d’un extrait de code C++, le raccourci if peut être utilisé en tant qu’extrait de code d’insertion ou comme un extrait de code 'entourer avec'. Si vous sélectionnez la ligne return FALSE; de code, puis choisissez Surround With>if, l'extrait est développé autour de la ligne.

if (true)
{
    return FALSE;
}

Paramètres de remplacement d’extraits de code

Les extraits de code peuvent contenir des paramètres de remplacement, qui sont des espaces réservés que vous devez remplacer pour s’adapter au code que vous écrivez. Dans l’exemple précédent, true est un paramètre de remplacement que vous remplacez par la condition appropriée. Le remplacement se répète pour chaque instance de ce paramètre de remplacement dans l’extrait de code.

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

Dans le menu contextuel dans un fichier de code Visual Basic, sélectionnez Extrait>Insérer un extrait de code.
Sélectionnezpropriétés, procédures, événements>définir une propriété dans > modèles de code.

Capture d’écran du menu extrait de code pour 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 changez newPropertyValue en m_property, chaque instance de newPropertyValue est modifiée. Si vous passez String à Int la déclaration de propriété, la valeur de la Set méthode change également en Int.

Meilleures pratiques pour l’utilisation d’extraits de code

Le code d’un extrait de code montre uniquement la façon la plus simple d’effectuer quelque chose. Pour la plupart des applications, le code doit être modifié en fonction de l’application.

Gestion des exceptions

En règle générale, les extraits de code Try...Catch capturent et relancent toutes les exceptions, mais ce n’est peut-être pas le bon choix pour votre projet. Pour chaque exception, il existe plusieurs façons de répondre. Pour obtenir des exemples, consultez Comment gérer une exception à l’aide de try/catch (C#) et Try... Catch... Enfin, instruction (Visual Basic).

Emplacements des fichiers

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

Recherchez un emplacement accessible. Les utilisateurs n’ont peut-être pas accès au dossier Program Files de l’ordinateur, de sorte que le stockage des fichiers utilisateur avec les fichiers d’application peut ne pas fonctionner.
Recherchez un emplacement sécurisé. Le stockage de 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 utilisateur individuelles, 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é de noms de fichiers non valides.
N’oubliez pas qu’un fichier sélectionné par l’utilisateur peut être supprimé avant que votre code 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’emplacement où vous l’utilisez dans le code source et de la façon dont vous la modifiez une fois dans le code. La liste suivante contient quelques domaines à prendre en compte :

Accès aux fichiers et aux bases de données
Sécurité de l’accès au code
Protection des ressources telles que les journaux d’événements et le Registre
Stockage des secrets
Vérification des entrées
Transfert de données vers des technologies de script

Pour plus d’informations, consultez Applications sécurisées.

Extraits de code téléchargés

Les extraits de code installés par Visual Studio ne sont pas des risques de sécurité eux-mêmes. Toutefois, ils peuvent créer des risques de sécurité dans votre application. Les extraits de code téléchargés à partir d’Internet doivent être traités avec une prudence extrême, comme tout autre contenu téléchargé. Téléchargez des extraits de code uniquement à partir de sites auxquels vous faites confiance, et utilisez un antivirus à jour up-to.

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

Code d’extrait de code qui pourrait endommager votre système si vous l’exécutez. Lisez attentivement le code source 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.
Extraits de code contenant des références ajoutées en mode silencieux à votre projet et peuvent être chargés n’importe où sur votre système. Vous pouvez télécharger ces références à partir du même emplacement à partir duquel 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 de segment de code.

Partager via