Commentaires C ++

«Le but des commentaires est de vous rappeler et de faire savoir aux autres comment fonctionne votre programme. Explications de code texte important et extraits de code qui doivent être commentés pendant que les applications de débogage sont toutes deux des exemples de commentaires multilignes. Le compilateur ne prend pas compte des commentaires. Les commentaires en C ++ peuvent durer une ou plusieurs lignes. Tout caractère présent à l'intérieur d'un commentaire est ignoré par le compilateur C ++. Vos commentaires devraient permettre aux utilisateurs externes de comprendre votre code.

Si les commentaires concernant les détails du programme ne sont pas fournis, quelqu'un qui lisait une énorme quantité de code sera perplexe. Rendre un code plus compréhensible en ajoutant des descriptions supplémentaires est possible avec des commentaires. Pour rendre le code compréhensible, les commentaires peuvent contenir une description d'algorithme. Si le code doit être réutilisé après une pause importante, les commentaires peuvent également être utiles pour l'individu. Les commentaires ne doivent pas être utilisés comme remplaçant pour une langue anglaise explication du code mal écrit. L'écriture de code propre et explicite devrait toujours être une priorité. Ensuite, utilisez la section des commentaires."

Exemple 1

Le commentaire en une seule ligne est représenté par la double barre «//». Les commentaires à une seule ligne sont indiqués en l'utilisant. Une seule ligne peut être commentée par ce. Étant donné qu'il a été conçu pour fonctionner avec la programmation C ++, il est connu sous le nom de commentaires de style C ++.

#inclure
// Exemple d'un commentaire unique
int main()

// corps de méthode principale
std :: cout << "Single line comment in c++";
retour 0;

Ici, nous avons d'abord importé la bibliothèque ioStream avec le mot clé C ++ inclut. Après cela, nous avons utilisé le double slash «//» et entré une ligne de texte qui démontre qu'il s'agit d'un programme de commentaires à une seule ligne. Entrer dans le corps principal où nous avons également commenté la ligne de texte, qui définit que le code se trouve dans la section Méthode principale.

Le commentaire à une seule ligne ne s'affiche pas sur l'écran de la console.

Exemple 2

/ * Toute ligne de texte * / est la représentation, avec le début une barre oblique et un astérisque (/ *) et la fin d'un astérisque et une barre oblique (* /). Les commentaires multi-lignes sont indiqués en l'utilisant. Plus d'une ligne peut être affectée par le commentaire. Il a d'abord été utilisé dans la programmation C, d'où le nom «Commentaire de style C."

/ * En utilisant une multi-ligne
Le commentaire est démontré
Dans un programme C ++.* /
#inclure
int main()

/ * À l'intérieur du commentaire multiline, le
Le code est expliqué. Le num variable est
déclaré et imprimé à l'écran * /
int num = 25;
std :: cout << "The numbers is:";
std :: cout<retour 0;

Ici, nous avons lancé notre programme avec le commentaire multiligne. Comme discuté, le commentaire multilin. Nous avons enveloppé notre paragraphe de texte dans le commentaire multiligne. Le texte donne les détails que nous avons utilisé les commentaires multilines dans le programme C ++. Ensuite, nous devons commencer la mise en œuvre du programme en incluant le module C ++. Après cela, nous avons introduit la méthode principale, à l'intérieur de laquelle nous avons à nouveau utilisé le texte multilin commenté. Le commentaire multiligne explique que «num» est le nom de variable, et nous avons affiché la valeur de variable «num» à l'écran.

Lors de la compilation de ce programme C ++, seule l'instruction d'impression s'affiche sur l'invite.

Exemple 3

Le code peut également être désactivé dans les commentaires pour l'empêcher d'exécuter. Par exemple, au lieu d'éliminer le code problématique lorsque nous rencontrons un problème lors de l'exécution du programme, nous pouvons utiliser des commentaires pour empêcher qu'il ne soit exécuté; Cela peut être un outil de débogage très utile.

#inclure
Utilisation de Namespace Std;
int main()
couter << "C++ Program\n";
// cout <<"Error Program;
couter << "C++ other Program";
retour 0;

Dans le programme ci-dessus, nous avons délibérément mis une commande d'erreur sur le cout. Notez que dans la deuxième commande cout, la chaîne est en dehors des citations, et nous utilisons les citations uniques. Cela génère l'exception.

Voici un exemple de la façon d'utiliser les commentaires en tant qu'outil de débogage. Pour éviter de générer une erreur, nous venons de commenter la commande d'erreur.

#inclure
Utilisation de Namespace Std;
int main()
couter << "C++ Program\n";
// cout <<"Error Program;
couter << "C++ other Program";
retour 0;

Maintenant, vous voyez que l'invite a imprimé les instructions COUT plutôt que de générer une exception.

Exemple 4

Les commentaires de blocs sont une forme particulière de commentaires multilines qui sont utilisés au début de chaque fichier ou fonction. Le créateur et le but du fichier sont divulgués dans ces remarques de blocs. Comment créer un commentaire de bloc est le suivant:

• Pour garder le commentaire aligné sur le code qui le suit, la ligne initiale est en retrait.
• Des informations sur l'utilisation prévue de la classe ou de la fonction sont fournies dans le commentaire.
• Entre la description du fichier et une liste de balises, il y a une ligne vierge dans le commentaire.

/ *
CS-102 C ++ 11, fichier.cpp
Objectif: Commentaires de documentation
@author Linux_User
@version 3.3 16/07/2022
* /
#inclure
Utilisation de Namespace Std;
int main()
// cout<<"C++ eaxmple of Documentation comment"
// Imprimer la déclaration de COUT
retour 0;

Ici, nous avons correctement documenté ce code de programme avec les commentaires bloqués. Vous pouvez voir que nous avons donné des informations sur le code, qui fournit le nom de l'auteur, les détails du fichier, la version du logiciel, ainsi que la date.

Exemple 5

Un commentaire à une seule ligne peut être imbriqué à l'intérieur d'un autre commentaire qui a plusieurs lignes. Aux paires de commentaires multi-lignes, néanmoins, cette logique est inapplicable. Il n'y a aucun moyen de nid un commentaire multi-ligne à l'intérieur d'un autre.

#inclure
Utilisation de Namespace Std;
int main()
/ *
// le commentaire à ligne unique
// le commentaire multiline commence ici, et la ligne de commentaire se termine ici * / /
retour 0;

Dans cet exemple particulier, nous avons utilisé le commentaire à la ligne unique imbriqué avec la représentation des commentaires multilignes. Nous avons enveloppé notre commentaire à une seule ligne avec la seule barre oblique "/" et l'astérisque "*". C'est ainsi que nous pouvons commenter plusieurs lignes de texte en C++.

Conclusion

Les commentaires C # à la ligne unique et multi-lignes ont été examinés. Les commentaires d'une ligne de longue durée se terminent à la première pause de ligne qui vient après le marqueur // commentaire. Soit le mettre après l'instruction du code, soit le mettre en haut. Il est considéré comme un commentaire s'il vient après une déclaration de code. Pendant la compilation, seul le texte présent entre les délimiteurs de commentaires sera reconnu comme le commentaire.