C Language
commentaires

Introduction

Syntaxe

• /*...*/
• //... (C99 et versions ultérieures uniquement)

/ * * / commentaires délimités

Un commentaire commence par une barre oblique suivie immédiatement d'un astérisque ( /* ) et se termine dès qu'un astérisque immédiatement suivi d'une barre oblique ( */ ) est rencontré. Tout ce qui se trouve entre ces combinaisons de caractères est un commentaire et est traité comme un espace vide (ignoré) par le compilateur.

/* this is a comment */

Le commentaire ci-dessus est un commentaire sur une seule ligne. Les commentaires de ce type /* peuvent couvrir plusieurs lignes, comme ceci:

/* this is a
multi-line
comment */

Bien que cela ne soit pas strictement nécessaire, une convention de style commune avec les commentaires multi-lignes consiste à placer des espaces et des astérisques sur les lignes après le premier, et /* et */ sur les nouvelles lignes, de sorte qu'ils soient tous alignés:

/* 
 * this is a
 * multi-line
 * comment
 */

Les astérisques supplémentaires n'ont aucun effet fonctionnel sur le commentaire car aucun d'entre eux n'a de barre oblique associée.

Ces /* type de commentaires peut être utilisé sur leur propre ligne, à la fin d'une ligne de code, ou même dans les lignes de code:

/* this comment is on its own line */
if (x && y) { /*this comment is at the end of a line */
    if ((complexCondition1) /* this comment is within a line of code */
            && (complexCondition2)) {
        /* this comment is within an if, on its own line */
    }
}

Les commentaires ne peuvent pas être imbriqués. C'est parce que tout /* ultérieur sera ignoré (dans le cadre du commentaire) et le premier */ atteint sera traité comme mettant fin au commentaire. Le commentaire dans l'exemple suivant ne fonctionnera pas :

/* outer comment, means this is ignored => /* attempted inner comment */ <= ends the comment, not this one => */

Pour commenter des blocs de code qui contiennent des commentaires de ce type, qui seraient autrement imbriqués, consultez l'exemple de commentaire utilisant le préprocesseur ci-dessous.

// commentaires délimités

// this is a comment

// each of these lines are a single-line comment
// note how each must start with
// the double forward-slash

// this comment is on its own line
if (x && y) { // this comment is at the end of a line
    // this comment is within an if, on its own line
}

Commenter en utilisant le préprocesseur

De gros morceaux de code peuvent également être "commentés" en utilisant les directives de préprocesseur #if 0 et #endif . Ceci est utile lorsque le code contient des commentaires sur plusieurs lignes qui, autrement, ne seraient pas imbriqués.

#if 0 /* Starts the "comment", anything from here on is removed by preprocessor */ 

/* A large amount of code with multi-line comments */  
int foo()
{
    /* lots of code */
    ...

    /* ... some comment describing the if statement ... */
    if (someTest) {
        /* some more comments */
        return 1;
    }

    return 0;
}

#endif /* 0 */

/* code from here on is "uncommented" (included in compiled executable) */
... 

Piège possible dû aux trigraphes

int x = 20;  // Why did I do this??/

int foo = 20; // Start at 20 ??/
int bar = 0;

// The following will cause a compilation error (undeclared variable 'bar')
// because 'int bar = 0;' is part of the comment on the preceding line
bar += foo;