Meilleures pratiques pour l'utilisation d'extraits de code IntelliSense

Article
08/10/2011

Le code dans chaque extrait de code IntelliSense affiche uniquement une méthode de base pour accomplir une tâche. Pour la plupart des applications, le code devra être modifié en fonction de l'application. Cette rubrique décrit plusieurs modifications courantes qui doivent être apportées au code.

Gestion des exceptions

En général, si le code contient un bloc Try…Catch, il interceptera et lèvera une nouvelle fois toutes les exceptions. Il se peut que cela ne soit pas le bon choix pour votre projet. Pour chaque exception, il existe plusieurs façons de répondre. Voici quelques actions possibles :

Ajoutez du code à chaque bloc Catch pour l'action choisie.
Ne faites rien, en supprimant le code qui apparaît dans le bloc Catch. Dans ce cas, l'application ignore l'erreur. Il est peu probable que votre application puisse récupérer normalement si vous choisissez cette solution.
Récupérez plus d'entrées de la part de l'utilisateur pour essayer de résoudre la condition.
Pendant l'exécution du bloc Try, annulez toutes les modifications apportées aux données d'application avant que l'exception n'ait été levée.
Répercutez l'exception vers la méthode d'appel.
Levez une exception que vous définissez pour cette application.
Supprimez l'instruction Catch pour cette exception et laissez la méthode d'appel la gérer. Cette solution est particulièrement appropriée si l'exception ne concerne pas votre tâche.
Ajoutez des blocs Catch supplémentaires au code pour intercepter des types spécifiques d'exceptions que vous souhaitez gérer.
Ajoutez un bloc Finally pour ajouter du code à exécuter après les blocs Try et Catch.

Remplacement des chaînes

Si le code contient une valeur de chaîne, il s'agit en général d'une chaîne spécifique, telle que "c:\filename.txt". Cette chaîne codée de manière irréversible est utile à des fins de démonstration, mais elle n'est probablement pas la chaîne correcte pour votre application. Voici des sources potentielles de chaînes pour votre application :

Une variable chaîne.
Une méthode ou une propriété qui retourne une chaîne, telle que la fonction InputBox.
Une chaîne d'un contrôle Windows Forms, par exemple TextBox ou ComboBox.

Emplacements des fichiers

D'après les noms affichés dans le code, la plupart des fichiers se situent soit dans Mes documents, soit dans c:\. Lorsque vous changez l'emplacement des fichiers, vous devez notamment prendre en compte les éléments suivants :

Trouver un emplacement accessible. Les utilisateurs n'ont peut-être pas accès au dossier \Program Files de l'ordinateur, donc stocker les fichiers avec les fichiers d'application n'est pas la solution appropriée.
Trouver un emplacement sécurisé. Le stockage des fichiers dans le dossier racine (c: \) ne constitue pas une solution sécurisée. Pour les données d'application, nous vous recommandons d'utiliser le dossier \Application Data. Pour les données utilisateur, l'application peut créer un fichier pour chaque utilisateur dans le dossier \Mes documents.
Utiliser un nom de fichier valide. Vous pouvez utiliser le OpenFileDialog, composant (Windows Forms) et le SaveFileDialog, composant (Windows Forms) pour réduire les risques de choisir des noms de fichiers non valides. Gardez à l'esprit qu'entre le moment où l'utilisateur sélectionne un fichier et le moment où votre code manipule le fichier, il se peut que le fichier ait été supprimé. En outre, l'utilisateur ne dispose peut-être pas des autorisations pour écrire dans le fichier.

Contrôles et composants

Les contrôles et les composants référencés dans le code ont habituellement un nom attribué par défaut par le concepteur, tel que Button1 ou TreeView1. Ces noms mettent en évidence le type de contrôle indiqué, mais ne correspondent peut-être pas aux noms que vous utilisez dans votre application.

Code manquant

Certains extraits de code affichent seulement une structure de langage vide, par exemple un bloc Try…Catch. Un autre scénario courant est lorsqu'une variable de validation, par exemple IsValid, a par défaut la valeur True. Le code fourni pourra être compilé et exécuté, mais il n'aura aucune fonctionnalité. Dans ces exemples, vous devrez ajouter le code correspondant à votre tâche.

Sécurité

Le niveau de sécurité d'un extrait de code dépend de l'emplacement où il est utilisé dans le code source et de la façon dont il est modifié après avoir été inséré dans le code. La liste suivante contient quelques-unes des zones qui doivent faire l'objet d'une attention particulière :

Accès aux fichiers et aux bases de données
Sécurité d'accès du code
Protection des ressources (par exemple les journaux des événements, le Registre)
Stockage des informations confidentielles
Vérification des entrées
Passages des données aux technologies de script

Pour plus d'informations, consultez Considérations relatives à la sécurité lors de l'utilisation d'extraits de code et Sécurisation des applications.