Lorsque vous travaillez avec le codage VBA dans Excel, vous pouvez facilement ajouter des commentaires lors de l'écriture du code.
Les commentaires en VBA peuvent être très utiles pour les débutants, où vous pouvez ajouter un commentaire à une ligne de code (ou à un bloc de code) qui explique ce qu'il fait. Ainsi, la prochaine fois que vous reviendrez au code, vous ne serez pas complètement perdu et aurez du contexte à cause des commentaires.
Même pour les programmeurs Excel VBA avancés, une fois que le code commence à dépasser quelques lignes, c'est une bonne idée d'ajouter du contexte à l'aide de commentaires (surtout s'il est possible que quelqu'un d'autre doive travailler sur le code à l'avenir)
Et comme il s'agit d'un commentaire, VBA l'ignore lors de l'exécution du code.
Dans ce court tutoriel Excel, je vais expliquer comment ajouter des commentaires dans VBA et toutes les meilleures pratiques qui l'entourent.
Ajout de commentaires en VBA dans Excel
Pour ajouter un commentaire en VBA, ajoutez simplement un signe apostrophe avant la ligne que vous souhaitez marquer comme commentaire.
Tout ce qui se trouve après le signe apostrophe dans cette ligne serait considéré comme un commentaire et VBA le transformerait en couleur verte (pour le différencier visuellement du code normal)
Il y a deux façons d'ajouter un commentaire en VBA :
- Avoir un commentaire dans une ligne séparée, où cette ligne commence par une apostrophe et a ensuite le texte du commentaire après elle
- Avoir un commentaire dans le cadre de la ligne de code normale, où après le code, vous avez un espace suivi d'une apostrophe, puis le commentaire (comme indiqué ci-dessous)
Bien que j'aie vu les deux utilisés par les programmeurs VBA, je préfère la première méthode où un commentaire a une ligne distincte.
Une autre méthode (old school) pour ajouter un commentaire consiste à faire suivre le mot « Rem » du commentaire.
Ici, Rem est l'abréviation de Remarque.
Rem a été utilisé à l'époque de BASIC et a été conservé dans les versions actuelles de VBA. Bien qu'il soit bon de savoir qu'il existe, je vous recommande d'utiliser uniquement la méthode de l'apostrophe lors de l'ajout de commentaires en VBA.Conversion d'une ligne de code (ou bloc de code) en commentaire
Parfois, vous pouvez avoir besoin de convertir une ligne de code existante (ou un bloc de code) en commentaires.
Les programmeurs le font souvent lorsqu'ils travaillent sur un code et qu'ils veulent essayer rapidement autre chose, tout en conservant le code déjà écrit.
Ainsi, vous pouvez rapidement commenter une ligne, en essayer une nouvelle et si vous souhaitez récupérer le code précédent, supprimez simplement l'apostrophe et reconvertissez ce commentaire en une ligne de code normale.
Pour une ligne (ou même quelques lignes), il est préférable d'ajouter manuellement l'apostrophe avant ces lignes.
Mais si vous avez un gros bloc de code, utilisez les étapes ci-dessous pour ajouter la possibilité de convertir un bloc de code entier en commentaire :
- Cliquez sur l'onglet Affichage
- Accédez à l'option Barre d'outils.
- Lorsque vous passez votre curseur dessus, vous verrez plus d'options
- Cliquez sur l'option Modifier. Cela fera apparaître la barre d'outils d'édition quelque part sur votre écran.
- Faites glisser les barres d'outils d'édition vers la zone des barres d'outils afin qu'elles s'y ancrent (au cas où elles ne seraient pas déjà ancrées)
- Sélectionnez le bloc de code que vous souhaitez commenter
- Cliquez sur l'option « Bloquer les commentaires » dans la barre d'outils
Les étapes ci-dessus convertiraient instantanément un bloc de code en commentaires en ajoutant une apostrophe devant chaque ligne de ce code.
Si vous souhaitez supprimer le commentaire et le reconvertir en lignes de code normales, sélectionnez à nouveau ce bloc de code et cliquez sur l'option « Décommenter le bloc » dans la barre d'outils Modifier
Changer la couleur du commentaire dans Excel VBA
Bien que VB ne permette pas beaucoup de formatage, il vous permet de changer la couleur du commentaire si vous le souhaitez.
Un de mes étudiants du cours VBA m'a envoyé un e-mail et m'a dit que la possibilité de changer la couleur des commentaires en VBA était vraiment utile pour les personnes souffrant de daltonisme.
Voici les étapes pour changer la couleur du commentaire dans Excel VBA :
- Ouvrez l'éditeur Visual Basic
- Cliquez sur l'option Outils dans le menu
- Cliquez sur Options
- Dans la boîte de dialogue Options, cliquez sur l'onglet « Format de l'éditeur »
- Dans les options Couleurs du code, sélectionnez Texte du commentaire
- Changer la couleur de premier plan et/ou d'arrière-plan
- Fermer la boîte de dialogue
Lorsque vous modifiez la couleur du commentaire, cela change également la couleur de tous les commentaires existants dans votre code.
Quelques bonnes pratiques lors de l'utilisation de commentaires dans VBA
Voici quelques-unes des meilleures pratiques à garder à l'esprit lors de l'utilisation de commentaires dans le code VBA.
- Gardez le commentaire significatif et ajoutez du contexte. Lorsque vous ajoutez un commentaire, réfléchissez à ce qui serait utile pour un nouvel utilisateur qui n'a jamais vu ce code et essaie de le comprendre.
- Évitez les commentaires excessifs car cela rendrait votre code un peu encombré. Bien qu'il soit acceptable d'ajouter plus de commentaires lorsque vous êtes débutant, à mesure que vous acquerrez plus d'expérience dans le codage VBA, vous n'auriez de toute façon pas besoin d'ajouter beaucoup de commentaires.
- Pour chaque nouveau sous-programme ou fonction, c'est une bonne idée d'ajouter un commentaire qui explique ce qu'il fait.
- Lorsque vous travaillez avec du code complexe, c'est une bonne idée d'ajouter des commentaires avant les conditions et les boucles, afin qu'il vous soit plus facile de comprendre ce que vous avez fait lorsque vous revisitez le code (ou lorsque quelqu'un d'autre parcourt le code)
Dans ce tutoriel, j'ai expliqué comment vous pouvez ajouter commentaires en VBA et quelques bonnes pratiques pour l'utiliser.
J'espère que vous avez trouvé ce tutoriel utile.
