Baza znanjaCentar za ispite
HRHrvatski
Odaberi jezik13

CKTIS / JavaScript

Komentari i dokumentacija

Komentari opisuju namjeru koda bez izvršavanja njihova sadržaja. Upoznajte zapis // i /* ... */, dokumentacijsku konvenciju /** ... */ i utjecaj završetaka redaka na raščlambu programa.

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

Sintaksa

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

Komentari objašnjavaju kod, osobito razloge za odluke i ograničenja. Njihov se sadržaj ne izvršava kao JavaScript. Urednička preporuka: objasnite ponajprije „zašto”, umjesto da ponavljate što očita naredba radi.

// započinje komentar koji traje do kraja retka ili izvornog teksta; završetak retka nije dio komentara. /* ... */ može zauzimati dio retka ili više redaka i završava na prvom */. Blok-komentari ne mogu se ugnijezditi.

Za ECMAScript je /** ... */ običan blok-komentar. Dokumentacijski zapis ne mijenja ponašanje funkcije niti nameće tipove; tumačenje dodatnih anotacija stvar je alata, a ne sintakse jezika.

Komentari se ponašaju kao bjeline, uz važnu iznimku: blok-komentar koji sadrži završetak retka tijekom sintaktičke raščlambe tretira se kao završetak retka. To može utjecati na automatsko umetanje točke-zareza (ASI), primjerice nakon return. Takvim komentarom nemojte razdvajati return od vraćene vrijednosti. Zaseban oblik #! dopušten je samo na samom početku izvornog teksta Script ili Module.

Primjeri

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

Rezultat

21

Prikazani kôd i navedeni rezultat provjereni su u izoliranom okruženju metodom zabilježenom u dokazu provjere za ovu točnu verziju.

Izvori