WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

Kommentare und Dokumentation

Kommentare beschreiben die Absicht von Code, ohne ihren Inhalt auszuführen. Lerne die Schreibweisen // und /* ... */, die Dokumentationskonvention /** ... */ und den Einfluss von Zeilenumbrüchen auf die Programmanalyse kennen.

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

Syntax

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

Kommentare erläutern Code, insbesondere die Gründe für Entscheidungen und bestimmte Einschränkungen. Ihr Inhalt wird nicht als JavaScript ausgeführt. Redaktionelle Empfehlung: Erkläre vor allem das „Warum“, statt die offensichtliche Wirkung einer Anweisung zu wiederholen.

// beginnt einen Kommentar, der bis zum Zeilenende oder bis zum Ende des Quelltexts reicht; der Zeilenabschluss gehört nicht zum Kommentar. /* ... */ kann einen Teil einer Zeile oder mehrere Zeilen umfassen und endet beim ersten */. Blockkommentare können nicht verschachtelt werden.

/** ... */ ist für ECMAScript ein gewöhnlicher Blockkommentar. Die Dokumentationsschreibweise ändert weder das Verhalten einer Funktion noch erzwingt sie Typen; die Auswertung zusätzlicher Annotationen ist Sache von Werkzeugen und nicht Teil der Sprachsyntax.

Kommentare verhalten sich wie Leerraum, mit einer wichtigen Ausnahme: Ein Blockkommentar, der einen Zeilenabschluss enthält, wird bei der syntaktischen Analyse wie ein Zeilenabschluss behandelt. Das kann sich auf die automatische Semikolon-Einfügung (ASI) auswirken, zum Beispiel nach return. Trenne return und den zurückgegebenen Wert nicht durch einen solchen Kommentar. Die separate Form #! ist nur ganz am Anfang des Quelltexts eines Skripts oder Moduls zulässig.

Beispiele

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

Ergebnis

21

Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.

Quellen