Kommentering av kode - Elektroniske krinsar og nettverk (EL-ELE vg1) - NDLA

Hopp til innhald
Fagartikkel

Kommentering av kode

Ein grei hugseregel er at du skal skrive så tydeleg kode at andre programmerarar skal kunne forstå han utan å måtte trenge kommentarar. I nokre tilfelle vil det likevel vere formålstenleg å kommentere koden.
Ein del linjer JavaScript-kode. Teksten har forskjellig farge avhengig av om det er ein del av programmet eller til dømes kommentarar. Illustrasjon.
Moderne programmeringsverktøy legg automatisk farge på koden. Dette gjer han lettare å lese og feilsøkje i. Bilete: Tron Bårdgård / CC BY-SA 4.0

I nokre tilfelle vil det kunne vere formålstenleg å skrive kommentarar, om ikkje anna for din eigen del. Når ein skal samarbeide med andre, vil det kunne vere nyttig å kommentere koden slik at andre kan sjå kva du har tenkt og gjort. Kommentering av koden kan òg brukast til feilsøking, og kommentarane vil ignorerast når koden blir køyrd.

Kommentar på éi linje

For å skrive ein kommentar i koden skriv du berre // før kommentaren. Du kan anten gjere dette på ei eiga linje eller bak koden på same linje. På denne måten kan du forklare kva som skjer på den linja.

Javascript
1// Dette er eit eksempel på ein kommentar.

Kommentarar på fleire linjer

Nokon gonger vil det vere behov for å skrive kommentarar som går over fleire linjer. Eit eksempel kan vere at du skal forklare noko øvst i fila di til ein annan person som eventuelt skal sjå på og forstå koden din. Då må du byrje kommentaren med /* og avslutte med */.

Javascript
1/* Dette er eit eksempel på ein kommentar.
2
3
4Denne kommentaren går over fleire linjer. */
Skrive av Jan Frode Lindsø.
Sist fagleg oppdatert 26.02.2020