Bloc de code de commentaire Excel VBA
Les commentaires dans la programmation VBA sont des instructions qui ne sont pas exécutées ou compilées mais qui ne sont là que pour fournir une brève description de toute fonction, variable, instruction, etc. Ces commentaires ne sont pas obligatoires mais sont utilisés pour rendre les blocs de code vba plus informatifs , lisible, organisé et facile à comprendre. De plus, si nous ne souhaitons pas supprimer certaines lignes de code et que nous ne voulons pas non plus qu'elles soient exécutées, nous pouvons les commenter.
Comment commenter le bloc de code VBA?
Vous pouvez télécharger ce modèle de commentaire de bloc VBA ici - Modèle de commentaire de bloc VBAExemple # 1 - Commentaire utilisant Apostrophe
Disons que nous souhaitons commenter une seule ligne / instruction / bloc dans un code VBA. Pour ce faire, Visual Basic Editor (VBE) doit être configuré.
L'éditeur Visual Basic est accessible comme suit:
Accédez à l'onglet Développeur Excel, puis cliquez sur Visual Basic Editor ou appuyez sur Alt + F11 pour ouvrir la fenêtre Visual Basic Editor.
En faisant cela, une fenêtre s'ouvre comme suit:
Cliquez avec le bouton droit sur le nom du classeur dans le volet «Projet-VBAProject», puis cliquez sur «Insérer» -> «Module» comme suit.
Nous pouvons maintenant écrire notre code ou procédure dans ce module:
Code:
Sous macro () 'Ceci est un commentaire End Sub
Nous pouvons donc voir dans la capture d'écran ci-dessus qu'en écrivant ce code dans le module, nous voyons que lorsque nous mettons ou insérons simplement une apostrophe avant une instruction / ligne, cette instruction se transforme en texte vert et est considérée comme un commentaire. On voit donc que lorsque l'on souhaite commenter une seule ligne, elle peut simplement être précédée d'une apostrophe.
Cette méthode peut également être utilisée pour commenter plusieurs lignes en mettant une apostrophe avant chaque ligne comme suit:
Exemple # 2 - Utilisation de la barre d'outils
Maintenant, disons que nous souhaitons ignorer et commenter un bloc entier de code ou plusieurs instructions du code. Dans un tel cas, utiliser une apostrophe avant chaque déclaration serait assez fastidieux et prend du temps alors que nous avons autant de déclarations à commenter. Donc, pour ce faire, il existe une option intégrée de 'Comment / Uncomment Block' dans VBE qui est initialement masquée dans la barre d'outils et peut être utilisée comme suit:
Étape 1: Sélectionnez les déclarations à partir du code
Sélectionnez les instructions de la macro / procédure qui doivent être commentées ci-dessous.
Étape 2: Cliquez sur Affichage -> Barres d'outils -> Personnaliser
Étape 3: Dans la fenêtre de personnalisation, cliquez sur Commandes -> Modifier, puis sélectionnez Bloc de commentaire
Cela générera ou ouvrira une fenêtre contextuelle «Personnaliser». Cliquez maintenant sur «Commandes» -> «Modifier», puis cliquez sur «Bloc de commentaire» et faites-le glisser dans la barre d'outils comme suit.
Avec cela, nous avons maintenant l'icône `` Bloc de commentaire '' sur la barre d'outils pour son accès facile.
Cliquez maintenant sur le 'Bloc de commentaires' dans la barre d'outils comme suit:
Ce faisant, les déclarations / lignes en surbrillance seraient maintenant commentées et se révéleraient de couleur verte comme ci-dessous:
Code:
Sub CommentLines () 'MsgBox "Première ligne de commentaire"' MsgBox "Deuxième ligne de commentaire" 'MsgBox "Troisième ligne de commentaire" End Sub
Nous pouvons donc voir dans la capture d'écran ci-dessus que les instructions vertes ne seront pas exécutées par la macro et ne seront traitées que comme un bloc de commentaires.
Exemple # 3 - Utilisation du mot-clé REM
Une autre méthode qui peut être utilisée pour faire une instruction / ligne en tant que commentaire consiste à ajouter le mot-clé 'REM' avant.
Voyons ci-dessous comment cela fonctionne:
Nous pouvons voir dans la capture d'écran ci-dessous que lorsque le mot-clé 'REM' est ajouté avant la déclaration: 'Ceci est un commentaire', alors il s'avère être vert et donc un commentaire.
Voyons maintenant comment ce mot-clé peut être utilisé pour commenter plusieurs lignes dans la capture d'écran ci-dessous.
Code:
Sub CommentUsingRem () Rem Ceci est un commentaire Rem Ceci est un commentaire Rem Ceci est un commentaire End Sub
Ainsi, nous pouvons voir qu'en dehors de l'utilisation d'apostrophe et de 'Comment Block', le mot clé 'REM' peut également être utilisé pour commenter des instructions de code ou de procédure. Cependant, l'utilisation du mot-clé 'REM' présente certaines limites:
- L'espace est obligatoire entre le mot-clé 'REM' et le début de l'instruction
- Il doit toujours être le premier mot par lequel commencer et ne peut pas être utilisé quelque part au milieu d'une ligne / instruction pour commenter le reste de la ligne.
Exemple # 4 - Décommenter les lignes commentées à l'aide de la barre d'outils
De la même manière que nous pouvons commenter un bloc de lignes en une seule fois, nous pouvons également décommenter les lignes commentées en utilisant l'option intégrée VBE 'Uncomment Block' de la même manière que ci-dessous:
Sélectionnez les instructions commentées dans la macro / procédure qui doivent être décommentées comme ci-dessous:
Maintenant, sélectionnez "Affichage ->" Barres d'outils "->" Personnaliser ".
Cela générera ou ouvrira une fenêtre contextuelle «Personnaliser». Cliquez maintenant sur 'Commandes' -> 'Modifier', puis cliquez sur 'Supprimer les commentaires' et faites-le glisser dans la barre d'outils comme suit:
Avec cela, nous avons maintenant l'icône `` Supprimer les commentaires '' dans la barre d'outils pour un accès facile.
Cliquez maintenant sur le 'Blocage de la mise en commentaire' de la barre d'outils comme suit:
Ce faisant, les instructions en surbrillance qui ont commenté se transforment maintenant en instructions exécutables du code ou de la procédure et changent de couleur du vert au noir comme ci-dessous:
Code:
Sub UncommentedLines () MsgBox "Première ligne de commentaire" MsgBox "Deuxième ligne de commentaire" MsgBox "Troisième ligne de commentaire" End Sub
Donc, ces déclarations ne sont plus des commentaires.
Choses à retenir
- Les commentaires sont de brèves déclarations explicatives qui peuvent être utilisées pour décrire les procédures.
- Les commentaires peuvent être utiles pour déboguer les codes.
- Toute instruction du code VBA qui suit une apostrophe est considérée comme un commentaire.
- En tant que bonne pratique de programmation, les commentaires peuvent être utilisés avant chaque section du code ou avant les déclarations de variables et les fonctions pour décrire leur objectif.
- L'éditeur VBA rend la couleur de police de l'instruction en vert pour indiquer qu'il s'agit d'un commentaire.
- Sauf si l'apostrophe est présente dans une chaîne, le compilateur ignore l'instruction suivant une apostrophe jusqu'à la fin de la ligne.
- Une apostrophe peut même être présente quelque part au milieu d'une ligne. Le texte après l'apostrophe sera traité comme un commentaire dans ce cas.
La capture d'écran suivante illustre ceci:
- Les commentaires n'affectent pas les performances du code.
- Le symbole de commentaire: Apostrophe ', ou «REM» doit être utilisé sur chaque ligne si les commentaires nécessitent plus d'une ligne.
- Par défaut, les commentaires apparaissent en vert dans la fenêtre de code.
- L'avantage d'utiliser l'apostrophe et 'Comment Block' par rapport au mot clé 'REM' est qu'ils nécessitent moins de mémoire et d'espace et sont également plus faciles à utiliser.
