Betydningen av kommentarer i programmering
La oss utforske hva kommentarer i kode egentlig er, og hvorfor de spiller en så viktig rolle i programmeringsverdenen.
Vi skal også se nærmere på to vanlige typer kommentarer og lære hvordan de skrives i 15 ulike programmeringsspråk.
Hva er kommentarer i programmeringskontekst?
Enkelt forklart er kommentarer tekstlinjer i koden som ikke vises for sluttbrukere. Disse tekstlinjene er ment som en veiledning og referanse for de som faktisk skriver koden.
Mer formelt sett, er en kommentar en beskrivelse av et program som forklarer hvordan det fungerer på en lettfattelig måte. De brukes ofte der det trengs ekstra klarhet for utvikleren som går gjennom koden. Dette bidrar til å øke lesbarheten av koden og reduserer behovet for tidkrevende kommunikasjon for å overføre kunnskap om hvordan koden fungerer.
Kompilatoren eller tolken ignorerer kommentarene i koden, og de påvirker derfor ikke det endelige resultatet av programmet. Kort sagt, kommentarer er en lettlest forklaring av spesifikke deler av koden.
De vanligste typene kommentarer
De fleste programmeringsspråk støtter to hovedtyper av kommentarer:
- Enkeltlinjeskommentar
- Flerlinjeskommentar (også kalt blokkkommentar)
Enkeltlinjeskommentarer er nyttige når du kun trenger å legge til en kort forklaring på en enkelt linje, for eksempel en beskrivelse av en bestemt betingelse eller en konstant. Flerlinjeskommentarer er derimot bedre egnet når du trenger å legge til større mengder informasjon, for eksempel en beskrivelse av en funksjon og hvordan den kan brukes.
Det finnes også andre typer kommentarer, som for eksempel dokumentkommentarer, men disse er ikke inkludert i denne artikkelen.
Hvorfor er det viktig å bruke kommentarer?
«Alle idioter kan skrive kode som en datamaskin kan forstå. Gode programmerere skriver kode som mennesker kan forstå.» – Martin Fowler
Den viktigste fordelen med å legge til kommentarer er økt lesbarhet og bedre forståelse av programmet. I tillegg gir kommentarer følgende fordeler:
- De gjør det lettere for kolleger og andre utviklere å forstå logikken uten å måtte lese omfattende dokumentasjon.
- De reduserer behovet for kommunikasjon mellom utviklere ved spørsmål.
- Kompilatoren/tolken ignorerer kommentarene.
- For åpen kildekode er de et must, siden du ikke alltid er tilgjengelig for å forklare hver funksjon til de millioner av utviklere som ønsker å bruke programmet.
Kommentarer i ulike programmeringsspråk
Nå som vi har lært hva kommentarer er og hvorfor de er nyttige, la oss se hvordan vi kan legge dem til i forskjellige programmeringsspråk.
Enkeltlinjeskommentar
// Dette er en enkeltlinjeskommentar i C/C++
Flerlinjeskommentar
/* Dette er en litt lengre flerlinjeskommentar i C/C++ */
Enkeltlinjeskommentar
# Dette er en enkeltlinjeskommentar i Python
Flerlinjeskommentar
# Dette er en litt lengre # flerlinjeskommentar i Python
Enkeltlinjeskommentar
// Dette er en enkeltlinjeskommentar i Java
Flerlinjeskommentar
/* Dette er en litt lengre flerlinjeskommentar i Java */
Enkeltlinjeskommentar
# Dette er en enkeltlinjeskommentar i Ruby
Flerlinjeskommentar
=begin Dette er en litt lengre flerlinjeskommentar i Ruby =end
Enkeltlinjeskommentar
// Dette er en enkeltlinjeskommentar i Golang
Flerlinjeskommentar
/* Dette er en litt lengre flerlinjeskommentar i Golang */
Enkeltlinjeskommentar
-- Dette er en enkeltlinjeskommentar i Haskell
Flerlinjeskommentar
{- Dette er en litt lengre
flerlinjeskommentar i Haskell -}
Enkeltlinjeskommentar
// Dette er en enkeltlinjeskommentar i Rust
Flerlinjeskommentar
/* Dette er en litt lengre flerlinjeskommentar i Rust */
Enkeltlinjeskommentar
<!-- Dette er en enkeltlinjeskommentar i HTML -->
Flerlinjeskommentar
<!-- Dette er en litt lengre flerlinjeskommentar i HTML -->
Enkeltlinjeskommentar
/* Dette er en enkeltlinjeskommentar i CSS */
Flerlinjeskommentar
/* Dette er en litt lengre flerlinjeskommentar i CSS */
Enkeltlinjeskommentar
// Dette er en enkeltlinjeskommentar i Javascript
Flerlinjeskommentar
/* Dette er en litt lengre flerlinjeskommentar i Javascript */
Enkeltlinjeskommentar
# Dette er en enkeltlinjeskommentar i R programmeringsspråk
Flerlinjeskommentar
R støtter ikke flerlinjeskommentarer.
Enkeltlinjeskommentar
% Dette er en enkeltlinjeskommentar i Erlang
Flerlinjeskommentar
Erlang støtter ikke flerlinjeskommentarer.
Enkeltlinjeskommentar
// Dette er en enkeltlinjeskommentar i PHP
Flerlinjeskommentar
/* Dette er en litt lengre flerlinjeskommentar i PHP */
Enkeltlinjeskommentar
# Dette er en enkeltlinjeskommentar i Perl
Flerlinjeskommentar
=begin Dette er en litt lengre flerlinjeskommentar i Perl =end
Enkeltlinjeskommentar
// Dette er en enkeltlinjeskommentar i Kotlin
Flerlinjeskommentar
/* Dette er en litt lengre flerlinjeskommentar i Kotlin */
Konklusjon
I denne artikkelen har vi gått gjennom det grunnleggende om kommentarer og de to vanligste typene – enkeltlinje- og flerlinjekommentarer. Vi har også sett på hvorfor kommentarer er nyttige og hvorfor du bør skrive dem der det er hensiktsmessig. Jeg håper du har lært noe nytt i dag!
Fortsett å utforske. Fortsett å lære! 👨💻