KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / JavaScript

Commentaar en documentatie

Commentaar beschrijft de bedoeling van code zonder de inhoud uit te voeren. Leer de syntaxis // en /* ... */, de documentatieconventie /** ... */ en hoe regeleinden de interpretatie van een programma kunnen beïnvloeden.

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

Commentaar licht code toe, vooral de redenen achter keuzes en beperkingen. De inhoud wordt niet als JavaScript uitgevoerd. Redactioneel advies: leg vooral uit waarom iets zo is, in plaats van te herhalen wat een voor de hand liggende instructie doet.

// begint een commentaar dat doorloopt tot het einde van de regel of de brontekst; het regeleindeteken maakt geen deel uit van het commentaar. /* ... */ kan een deel van een regel of meerdere regels beslaan en eindigt bij de eerste */. Blokcommentaar kan niet worden genest.

Voor ECMAScript is /** ... */ een gewoon blokcommentaar. De documentatienotatie verandert het gedrag van een functie niet en dwingt geen typen af; het interpreteren van aanvullende annotaties is een taak voor tools en geen onderdeel van de taalsyntaxis.

Commentaar gedraagt zich als witruimte, met één belangrijke uitzondering: een blokcommentaar met een regeleindeteken wordt bij syntactische analyse behandeld als een regeleindeteken. Dit kan invloed hebben op automatische puntkomma-invoeging (ASI), bijvoorbeeld na return. Scheid return en de geretourneerde waarde niet met zo’n commentaar. De aparte vorm #! is alleen toegestaan helemaal aan het begin van de brontekst van een Script of Module.

Voorbeelden

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

Resultaat

21

De getoonde code en het opgegeven resultaat zijn in een geïsoleerde omgeving geverifieerd met de methode die in het verificatiebewijs voor exact deze versie is vastgelegd.

Bronnen