Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / JavaScript

Commenti e documentazione

I commenti descrivono l’intento del codice senza eseguirne il contenuto. Scopri le sintassi // e /* ... */, la convenzione di documentazione /** ... */ e come i terminatori di riga possono influire sull’analisi del programma.

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

Sintassi

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

I commenti spiegano il codice, soprattutto le ragioni delle decisioni e i vincoli. Il loro contenuto non viene eseguito come JavaScript. Consiglio redazionale: spiega soprattutto il «perché», invece di ripetere ciò che fa un’istruzione ovvia.

// avvia un commento che continua fino alla fine della riga o del testo sorgente; il terminatore di riga non fa parte del commento. /* ... */ può occupare una parte di una riga o più righe e termina al primo */. I commenti a blocco non possono essere annidati.

Per ECMAScript, /** ... */ è un normale commento a blocco. La notazione documentale non modifica il comportamento di una funzione e non impone tipi; l’interpretazione di annotazioni aggiuntive è affidata agli strumenti, non fa parte della sintassi del linguaggio.

I commenti si comportano come spazi bianchi, con un’importante eccezione: durante l’analisi sintattica, un commento a blocco che contiene un terminatore di riga viene trattato come un terminatore di riga. Questo può influire sull’inserimento automatico del punto e virgola (ASI), per esempio dopo return. Non separare return dal valore restituito con un commento di questo tipo. La forma distinta #! è consentita solo all’inizio assoluto del testo sorgente di uno Script o di un Module.

Esempi

/** 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);

Risultato

21

Il codice mostrato e il risultato dichiarato sono stati verificati in un ambiente isolato con il metodo registrato nella prova di verifica di questa versione esatta.

Fonti