Prise de notes dans vos programmes : utilisation des commentaires

  • Article

Mise à jour : novembre 2007

Dans cette leçon, vous apprendrez comment placer des commentaires dans le code de vos programmes.

Le code qui compose un programme peut être difficile à lire et à comprendre, en particulier si vous n'en êtes pas l'auteur d'origine. En utilisant des commentaires, vous pouvez créer des remarques destinées à vous-même ou à d'autres utilisateurs de votre code.

Les commentaires sont des entrées de texte dans l'éditeur de code qui sont ignorées par le compilateur Visual Basic à l'exécution du programme. Vous pouvez donc vous adresser une remarque qui explique la fonction d'une section de code particulière de votre programme, ou qui vous rappelle d'éventuelles tâches de programmation à terminer.

Pour créer un commentaire, débutez une ligne par le caractère '. L'exemple suivant montre comment utiliser un commentaire.

' This is a comment. WOW!

Vous pouvez également ajouter des commentaires à la fin des lignes en utilisant le caractère '. Cette utilisation est fréquente pour fournir des commentaires relatifs à des lignes de code individuelles, comme l'illustre l'exemple suivant.

MsgBox("Hello World!") ' This line causes a message box to appear.

Comme dans le cas de commentaires qui occupent leur propre ligne, le programme ignore, ici aussi, tout ce qui suit le caractère ' sur la ligne.

Utilisation des commentaires pour le débogage

Une autre utilisation répandue des commentaires consiste à empêcher temporairement une ligne de code de s'exécuter pendant que vous déboguez votre programme. Prenons l'exemple d'une ligne de code affichant un message.

MsgBox("Hello World!")

Si vous souhaitez exécuter le programme sans afficher ce message, mais sans pour autant supprimer la ligne de manière définitive, utilisez le caractère de commentaire (') pour la dissimuler temporairement à votre programme, comme illustré ci-dessous.

' MsgBox("Hello World!")

Etant donné que tout ce qui suit le caractère ' est ignoré, le programme s'exécute sans exécuter cette ligne. Pour afficher à nouveau le message, il vous suffit de supprimer le caractère '.

Essayez !

Pour insérer des commentaires

  1. Dans le menu Fichier, sélectionnez NouveauProjet.

  2. Dans la boîte de dialogue Nouveau projet, dans le volet Modèles, cliquez sur Application Windows.

  3. Dans la zone Nom, tapez Comments, puis cliquez sur OK.

    Un nouveau projet Windows Forms s'ouvre.

  4. Double-cliquez sur le formulaire pour ouvrir l'éditeur de code.

  5. Dans le gestionnaire d'événements Form1_Load, tapez le code suivant.

    ' This code will cause two message boxes to appear
MsgBox("This is Message Box 1") ' Display Message Box 1
MsgBox("This is Message Box 2") ' Display Message Box 2

  6. Appuyez sur F5 pour exécuter le programme.

    Le programme démarre et les deux messages s'affichent tour à tour.

  7. Dans le menu Déboguer, choisissez Arrêter le débogage pour terminer le programme.

  8. Dans l'éditeur de code, ajoutez un caractère de commentaire (') à la première ligne du message, comme suit.

    ' MsgBox("This is MessageBox 1") ' Ignore Message Box 1

  9. Appuyez sur F5 pour exécuter le programme.

    Remarquez que, cette fois, la première ligne de message est ignorée par le programme, et que seul le deuxième message s'affiche.

Étapes suivantes

Dans cette leçon, vous avez appris à utiliser des commentaires pour placer des remarques dans votre code et désactiver individuellement et temporairement des lignes de code. Cette leçon termine la série sur le débogage. Dans la série de leçons suivante, vous apprendrez comment utiliser une base de données pour enregistrer et extraire des informations pour votre programme.

Leçon suivante : Gestion de vos enregistrements : utilisation de données dans votre programme

Voir aussi

Concepts

Commentaires dans le code

Autres ressources

Qu'est-ce qui s'est mal passé ? Recherche et résolution des erreurs à l'aide du débogage