Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / JavaScript

Komentáře a dokumentace

Komentáře popisují záměr kódu, aniž by se jejich obsah vykonával. Seznamte se se zápisem // a /* ... */, dokumentační konvencí /** ... */ a vlivem konců řádků na syntaktickou analýzu programu.

Verze: 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 */

Komentáře vysvětlují kód, zejména důvody rozhodnutí a omezení. Jejich obsah se nevykonává jako JavaScript. Redakční doporučení: vysvětlujte především „proč“, místo abyste opakovali, co dělá zřejmý příkaz.

// zahajuje komentář, který pokračuje do konce řádku nebo zdrojového textu; znak konce řádku není součástí komentáře. /* ... */ může zabírat část řádku nebo více řádků a končí na prvním */. Blokové komentáře nelze vnořovat.

Pro ECMAScript je /** ... */ obyčejný blokový komentář. Dokumentační zápis nemění chování funkce ani nevynucuje typy; interpretace dalších anotací je záležitostí nástrojů, nikoli syntaxe jazyka.

Komentáře se chovají jako bílé znaky, s důležitou výjimkou: blokový komentář obsahující znak konce řádku se při syntaktické analýze považuje za konec řádku. To může ovlivnit automatické vkládání středníků (ASI), například po return. Takovým komentářem neoddělujte return od vrácené hodnoty. Samostatná forma #! je povolena pouze na úplném začátku zdrojového textu Scriptu nebo Modulu.

Příklady

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

Výsledek

21

Zobrazený kód a uvedený výsledek byly ověřeny v izolovaném prostředí metodou zaznamenanou v dokladu o ověření této přesné verze.

Zdroje