Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / C++

Commentaires et documentation

C++ propose des commentaires // qui s’étendent jusqu’à la fin d’une ligne et des commentaires de bloc /* ... */. Ils permettent d’expliquer le code et de rédiger de la documentation sans exécuter leur contenu. Les commentaires de bloc ne peuvent pas être imbriqués.

Version : C++23; repository compiler flag, production runtime not attested

Syntaxe

// comment
/* comment */

Un commentaire // se termine juste avant le caractère de nouvelle ligne suivant. Un commentaire /* ... */ peut s’étendre sur plusieurs lignes et se termine au premier */. Les commentaires de bloc ne sont pas imbriqués : un autre /* ne démarre pas de commentaire interne.

Lors de la traduction, chaque commentaire est remplacé par une espace, tandis que les caractères de nouvelle ligne sont conservés. Ainsi, int/**/value sépare int et value, alors que va/**/lue ne forme pas l’identifiant value. La fusion des lignes a lieu avant la reconnaissance des commentaires : un \ à la fin d’une ligne contenant un commentaire // peut faire absorber à ce commentaire la ligne physique suivante. Évitez cette écriture.

Les formes documentaires telles que /// et /** ... */ sont des commentaires ordinaires pour le langage ; leur interprétation comme documentation dépend d’outils distincts. Privilégiez l’explication de l’objectif, des hypothèses et des contraintes plutôt que la répétition des instructions du code. Dans l’exemple, le commentaire /// décrit add et le commentaire de bloc sépare des jetons dans une expression.

Cette entrée concerne C++23. La source fournie est un brouillon de travail en évolution, et non une édition C++23 figée. Un réglage du mode de compilation dans un dépôt ne certifie pas l’environnement d’exécution de production.

Exemples

#include <iostream>

/// Return the sum of two integers.
/// Precondition: The mathematical sum of a and b is representable as int.
int add(int a, int b) {
    return a /* first operand */ + b;
}

int main() {
    // Print the result once.
    std::cout << add(2, 3) << '\n';
}

Résultat

5

Le code affiché et le résultat déclaré ont été vérifiés dans un environnement isolé selon la méthode consignée dans la preuve de vérification de cette version exacte.

Sources