Kommentarer er tekst i koden som ikke påvirker hvordan programmet kjører. De brukes til å forklare koden for deg selv eller andre som leser programmet senere. Kommentarer gjør koden enklere å forstå og vedlikeholde.
I JavaScript finnes det to hovedmåter å skrive kommentarer på:
Enkeltlinje-kommentarer Bruk // for å skrive kommentarer på én linje:
//
// Dette er en kommentar på én linje const navn = "Karl"; // Kommentar kan også stå etter en kode
Flerelinje-kommentarer Bruk /* ... */ når kommentaren går over flere linjer:
/* ... */
/* Dette er en kommentar som går over flere linjer. Den kan forklare mer komplekse deler av koden. */ const alder = 17;
Forklar hvorfor, ikke hva: Koden viser ofte hva som skjer, men kommentaren bør forklare hvorfor du gjør det.
// Beregner rabatt fordi kunden er medlem const prisEtterRabatt = pris * 0.9;
Komplisert kode: Hvis en algoritme eller funksjon er vanskelig å forstå, legg til en kommentar som forklarer logikken.
TODOs og påminnelser: Kommentarer kan brukes for å markere ting som må gjøres senere.
// TODO: Sjekk at brukernavn ikke inneholder spesialtegn
Unødvendige kommentarer: Ikke kommenter åpenbare ting.
let x = 5; // Setter x til 5 → unødvendig
Gamle eller feilaktige kommentarer: Hvis koden endres, må også kommentaren oppdateres. Ellers kan det forvirre mer enn det hjelper.
Skriv kommentarer som er korte, tydelige og presise.
Kommenter bare det som er nødvendig – god kode bør ofte være selvforklarende.
Bruk standardiserte merker som TODO eller FIXME for å markere oppgaver.
TODO
FIXME
Kommentarer bør være på samme språk som koden diskuteres i (ofte engelsk i profesjonell kode, norsk kan brukes i undervisning).
Kommentarer er altså et verktøy for å gjøre koden din mer lesbar og forståelig, men de er ikke en erstatning for ryddig, godt strukturert kode. God praksis handler om å bruke kommentarer smart og målrettet.
Her er noen eksempler på gode og dårlige kommentarer i JavaScript:
Kommentarer som er overflødige eller forvirrende:
let x = 5; // Setter x til 5 const navn = "Karl"; // Dette er et navn // Legger til 1 til i tallet x = x + 1;
Hvorfor dårlig:
Kommentarene sier bare det som allerede står i koden.
De gir ingen ekstra informasjon om hvorfor koden finnes eller hva den gjør i sammenheng.
Kommentarer som forklarer logikk, hensikt eller påminnelser:
// Beregner pris etter rabatt for medlemmer const prisEtterRabatt = pris * 0.9; /* Sjekker om brukernavn er gyldig: - Skal være mellom 3 og 15 tegn - Ingen spesialtegn */ function erGyldigBrukernavn(navn) { return navn.length >= 3 && navn.length <= 15 && /^[a-zA-Z0-9]+$/.test(navn); } // TODO: Legg til funksjon for å sende velkomst-epost til nye brukere
Hvorfor bra:
Kommentarene forklarer hvorfor koden gjør det den gjør.
Flerelinje-kommentaren gir klar dokumentasjon for en funksjon.
TODO viser at noe skal implementeres senere.
Skriv kommentarer som forklarer hensikten, ikke det som allerede står i koden.
Bruk kommentarer for komplekse deler av koden eller for oppgaver som gjenstår.
Hold kommentarene kortfattede og lettleste.
Når vi lager programvare eller nettsider, er det ikke nok å bare skrive koden. Vi må også kunne d...
© 2024 • Contents under CC-BY-NC • Maintained by Karl Arne Dalsaune