Commentaires

Les commentaires sont une forme de documentation dans le code. Lorsqu'ils sont insrs dans un programme, ils sont ignors par le compilateur; ils sont uniquement destins tre utiliss sous forme de notes par les humains qui lisent le code source. Bien que le standard C++ n'intgre pas un style de documentation intgre, il existe plusieurs utilitaires qui gnrent de la documentation partir de plusieurs formats de commentaires.

Syntaxe

1) Souvent appels commentaires style C ou commentaires multi-lignes.

2) Souvent appels commentaires style C++ ou commentaires mono-lignes.

Style C

Les commentaires style C sont gnralement utiliss pour commenter des gros blocs de texte mme sils peuvent tre utiliss pour commenter les lignes simples. Pour insrer 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 utiliss pour indiquer les blocs de documentation, ce qui est lgal parce que le deuxime astrisque est simplement considre comme faisant partie du commentaire. Les commentaires style C ne peuvent pas tre imbriqus.

On prfre souvent les commentaires style C dans des environnements o C et C++ peuvent tre mlangs, car ce sont les seuls commentaires qui peuvent tre utiliss dans la norme C (avant C99).

Style C++

Les commentaires style C++ sont gnralement utiliss 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 trs 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;
}