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

Hopp til innhold
Fagartikkel

Kommentering av kode

En grei huskeregel er at du skal skrive så tydelig kode at andre programmerere skal kunne forstå den uten å måtte trenge kommentarer. I noen tilfeller vil det likevel være hensiktsmessig å kommentere koden.
En del linjer JavaScript-kode. Teksten har forskjellig farge avhengig av om det er en del av programmet eller for eksempel kommentarer. Illustrasjon.
Moderne programmeringsverktøy legger automatisk farge på koden. Dette gjør den lettere å lese og feilsøke i. Bilde: Tron Bårdgård / CC BY-SA 4.0

I noen tilfeller vil det kunne være hensiktsmessig å skrive kommentarer, om ikke annet for din egen del. Når man skal samarbeide med andre, vil det kunne være nyttig å kommentere koden slik at andre kan se hva du har tenkt og gjort. Kommentering av koden kan også brukes til feilsøking, og kommentarene vil ignoreres når koden kjøres.

Kommentar på éi linje

For å skrive en kommentar i koden skriver du bare // før kommentaren. Du kan enten gjøre dette på ei egen linje eller bak koden på samme linje. På denne måten kan du forklare hva som skjer på den linja.

Javascript
1// Dette er et eksempel på en kommentar.

Kommentarer på flere linjer

Noen ganger vil det være behov for å skrive kommentarer som går over flere linjer. Et eksempel kan være at du skal forklare noe øverst i filen din til en annen person som eventuelt skal se på og forstå koden din. Da må du begynne kommentaren med /* og avslutte med */.

Javascript
1/* Dette er et eksempel på en kommentar.
2
3
4Denne kommentaren går over flere linjer. */
Skrevet av Jan Frode Lindsø.
Sist faglig oppdatert 26.02.2020