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

CKTIS / JavaScript

Commentaires et documentation

Les commentaires décrivent l’intention du code sans exécuter leur contenu. Découvrez les syntaxes // et /* ... */, la convention de documentation /** ... */ et l’influence des fins de ligne sur l’analyse du programme.

Version : ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Syntaxe

// comment
/* block comment */
/** documentation comment */

Les commentaires servent à expliquer le code, notamment les raisons des décisions et les contraintes. Leur contenu n’est pas exécuté comme du JavaScript. Conseil de rédaction : expliquez surtout le « pourquoi », au lieu de répéter ce que fait une instruction évidente.

// commence un commentaire qui se prolonge jusqu’à la fin de la ligne ou du texte source ; le terminateur de ligne ne fait pas partie du commentaire. /* ... */ peut occuper une partie d’une ligne ou plusieurs lignes et se termine au premier */. Les commentaires de bloc ne peuvent pas être imbriqués.

Pour ECMAScript, /** ... */ est un commentaire de bloc ordinaire. La notation documentaire ne modifie pas le comportement d’une fonction et n’impose pas de types ; l’interprétation d’annotations supplémentaires relève des outils, et non de la syntaxe du langage.

Les commentaires se comportent comme des espaces blancs, avec une exception importante : un commentaire de bloc contenant un terminateur de ligne est traité comme un terminateur de ligne lors de l’analyse syntaxique. Cela peut influer sur l’insertion automatique de points-virgules (ASI), par exemple après return. Ne séparez pas return de la valeur renvoyée par un tel commentaire. La forme distincte #! n’est autorisée qu’au tout début du texte source d’un Script ou d’un Module.

Exemples

/** Compute the total price. */
function total(price, quantity) {
  // Keep the calculation in one place.
  return price * quantity;
}

const result = total(7, /* quantity */ 3);
console.log(result);

Résultat

21

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