Comments

Les commentaires servent de documentation intégrée au code. Lorsqu'ils sont insérés dans un programme, ils sont effectivement ignorés par le compilateur ; ils sont uniquement destinés à être utilisés comme notes par les humains qui lisent le code source. Bien qu'une documentation spécifique ne fasse pas partie du standard C++, plusieurs utilitaires existent qui analysent les commentaires avec différents formats de documentation.

Syntaxe

Tous les commentaires sont supprimés du programme lors de la phase de traduction 3 en remplaçant chaque commentaire par un unique caractère d'espacement.

Style C

Les commentaires de style C sont généralement utilisés pour commenter de grands blocs de texte, cependant, ils peuvent être utilisés pour commenter des lignes individuelles. Pour insérer un commentaire de style C, entourez simplement le texte avec /* et */ ; cela fera que le contenu du commentaire sera ignoré par le compilateur. Bien que cela ne fasse pas partie du standard C++, /** et */ sont souvent utilisés pour indiquer des blocs de documentation ; ceci est légal car la deuxième astérisque est simplement traitée comme faisant partie du commentaire. Les commentaires de style C ne peuvent pas être imbriqués.

Style C++

Les commentaires de style C++ sont généralement utilisés pour commenter des lignes individuelles, cependant, plusieurs commentaires de style C++ peuvent être placés ensemble pour former des commentaires multilignes. Les commentaires de style C++ indiquent au compilateur d'ignorer tout contenu entre // et un saut de ligne.

Notes

Parce que les commentaires sont supprimés avant l'étape du préprocesseur, une macro ne peut pas être utilisée pour former un commentaire et un commentaire de style C non terminé ne déborde pas d'un fichier inclus via #include.

En plus du commentaire, d'autres mécanismes utilisés pour l'exclusion de code source sont

#if 0
    std::cout << "ceci ne sera pas exécuté ni même compilé\n";
#endif

et

if (false)
{
    std::cout << "ceci ne sera pas exécuté\n";
}

Exemple

#include <iostream>
/* C-style comments can contain
multiple lines */
/* or just one */
/**************
 *  you can insert any *, but
 *  you can't make comments nested
 */
// C++-style comments can comment one line
// or, they can
// be strung together
int main()
{
    // comments are removed before preprocessing,
    // so ABC is "1", not "1//2134", and "1 hello world"
    // will be printed
#define ABC 1//2134
    std::cout << ABC << " hello world\n";
    // The below code won't be run
    // return 1;
    // The below code will be run
    return 0;
}

1 hello world

Voir aussi