Notes
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Lorsque vous lisez les exemples de code, vous rencontrez souvent le symbole de commentaire ('). Ce symbole indique au compilateur Visual Basic d’ignorer le texte suivant celui-ci ou le commentaire. Les commentaires sont de brèves notes explicatifs ajoutées au code pour l’avantage de ceux qui le lisent.
Il est recommandé de commencer toutes les procédures avec un bref commentaire décrivant les caractéristiques fonctionnelles de la procédure (ce qu’elle fait). C’est pour votre propre avantage et l’avantage de toute autre personne qui examine le code. Vous devez séparer les détails de l’implémentation (comment la procédure le fait) des commentaires qui décrivent les caractéristiques fonctionnelles. Lorsque vous incluez des détails d’implémentation dans la description, n’oubliez pas de les mettre à jour lorsque vous mettez à jour la fonction.
Les commentaires peuvent suivre une commande sur la même ligne ou occuper une ligne entière. Les deux sont illustrés dans le code suivant.
' This is a comment beginning at the left edge of the screen.
text1.Text = "Hi!" ' This is an inline comment.
Si votre commentaire nécessite plusieurs lignes, utilisez le symbole de commentaire sur chaque ligne, comme l’illustre l’exemple suivant.
' This comment is too long to fit on a single line, so we break
' it into two lines. Some comments might need three or more lines.
Recommandations en matière de commentaires
Le tableau suivant fournit des instructions générales sur les types de commentaires qui peuvent précéder une section de code. Il s’agit de suggestions ; Visual Basic n’applique pas de règles pour l’ajout de commentaires. Écrivez ce qui fonctionne le mieux, à la fois pour vous et pour toute autre personne qui lit votre code.
| Type de commentaire | Description du commentaire |
|---|---|
| Objectif | Décrit ce que fait la procédure (pas comment elle le fait) |
| Hypothèses | Répertorie chaque variable externe, contrôle, fichier ouvert ou autre élément accessible par la procédure |
| Effets | Répertorie chaque variable externe affectée, contrôle ou fichier, et l’effet qu’il a (uniquement s’il n’est pas évident) |
| Données d'entrée | Spécifie l’objectif de l’argument |
| Retours | Explique les valeurs retournées par la procédure |
N’oubliez pas les points suivants :
Chaque déclaration de variable importante doit être précédée d’un commentaire décrivant l’utilisation de la variable déclarée.
Les variables, les contrôles et les procédures doivent être nommés suffisamment clairement pour que les commentaires soient nécessaires uniquement pour des détails d’implémentation complexes.
Vous ne pouvez pas faire suivre une séquence de continuation par un commentaire sur la même ligne.
Vous pouvez ajouter ou supprimer des symboles de commentaire pour un bloc de code en sélectionnant une ou plusieurs lignes de code et en choisissant les boutons Commenter (
) et Décommenter (
) dans la barre d’outils Modifier.
Remarque
Vous pouvez également ajouter des commentaires à votre code en précédant le texte avec le REM mot clé. Toutefois, le ' symbole et les boutons Commentaire/uncomment sont plus faciles à utiliser et nécessitent moins d’espace et de mémoire.
Voir aussi
Collaborer avec nous sur GitHub
La source de ce contenu se trouve sur GitHub, où vous pouvez également créer et examiner les problèmes et les demandes de tirage. Pour plus d’informations, consultez notre guide du contributeur.
