Commentaires
Les commentaires sont une forme de documentation « dans le code ». Lorsqu'ils sont insérés dans un programme, ils sont ignorés par le compilateur ; ils sont uniquement destinés à être utilisés sous forme de notes par les humains qui lisent le code source. Bien que le standard C++ n'intègre pas un style de documentation intégrée, il existe plusieurs utilitaires qui génèrent de la documentation à partir de plusieurs formats de commentaires.
Syntaxe
/* comment */
|
(1) | ||||||||
// comment\n
|
(2) | ||||||||
1) Souvent appelés « commentaires style C » ou commentaires multi-lignes.
2) Souvent appelés « commentaires style C++ » ou commentaires mono-lignes.
Style C
Les commentaires style C sont généralement utilisés pour commenter des gros blocs de texte même s’ils peuvent être utilisés pour commenter les lignes simples. Pour insérer un commentaire style C, encadrez le texte avec /* et */, ce qui aura pour effet que le contenu du commentaire sera ignoré par le compilateur. Bien qu'il ne font pas partie du standard C++, /** et */ sont souvent utilisés pour indiquer les blocs de documentation, ce qui est légal parce que le deuxième astérisque est simplement considérée comme faisant partie du commentaire. Les commentaires style C ne peuvent pas être imbriqués.
On préfère souvent les commentaires style C dans des environnements où C et C++ peuvent être mélangés, car ce sont les seuls commentaires qui peuvent être utilisés dans la norme C (avant C99).
Style C++
Les commentaires style C++ sont généralement utilisés pour commenter une ligne ; cependant, plusieurs commentaires style C++ peuvent se suivre pour former un commentaire le plusieurs lignes. Les commentaires style C++ indiquent au compilateur qu'il faut ignorer tout le contenu entre // et une nouvelle ligne, ce qui les rend très utiles.
Exemple
/* C-style comments can contain
multiple lines */
/* or just one */
// C++-style comments can comment one line
// or, they can
// be strung together
int main()
{
// The below code won't be run
// return 1;
// The below code will be run
return 0;
}