La oss finne ut hva kommentarer er og hvorfor de er viktige i programmering.
Vi dekker også to vanlige typer kommentarer og hvordan du skriver dem på 15 forskjellige programmeringsspråk.
Innholdsfortegnelse
Hva er kommentarer i programmering?
Kommentarer i lekmannstermer er tekstbiter som ikke vil være synlige for sluttbrukere og er til referanse for folk som skriver kode.
Litt mer formelt er En kommentar en beskrivelse av et program om hvordan det fungerer i et enkelt lesbart format. Disse brukes vanligvis på steder der det må gis noe ekstra klarhet til utvikleren som leser gjennom koden. Dermed hjelper dette med å forbedre kodelesbarheten og reduserer tid og kommunikasjon som vil være nødvendig for å overføre kunnskap.
Kompilator/tolk ignorerer ganske enkelt kommentarene i koden din og påvirker dermed ikke sluttresultatet til programmet. Så i et nøtteskall er kommentarer som en enkel lesbar forklaring på visse deler av kode.
Vanlige typer kommentarer
De fleste programmeringsspråk støtter 2 typer kommentarer.
- Enkeltlinjekommentar
- Flerlinjekommentar/blokkkommentarer
Som navnet antyder er enkeltlinjekommentarer nyttige når man trenger å legge til liten enkeltlinjetekst, f.eks. en bestemt tilstand, en konstant verdi som trenger en liten beskrivelse. Mens multi-line fungerer bedre når vi har en større mengde informasjon som skal legges til som en beskrivelse av en funksjon og hvordan man kan bruke den osv.
Det finnes noen andre typer kommentarer som Dokumentkommentarer, men det er utenfor rammen av denne artikkelen.
Hvorfor bør du legge til kommentarer?
«Enhver idiot kan skrive kode som en datamaskin kan forstå. Gode programmerere skriver kode som mennesker kan forstå.» – Martin Fowler
Den største fordelen med å legge til kommentarer er den forbedrede lesbarheten og bedre forståelse av programmet. Bortsett fra dette inkluderer noen andre fordeler –
- Kommentarer gjør det superenkelt for jevnaldrende og til og med andre utviklere å forstå logikken uten å lese gjennom lang dokumentasjon.
- Redusert kommunikasjon mellom utviklere for små tvil
- Kommentarer ignoreres av kompilatoren/tolkene.
- For åpen kildekode-programvare er disse et must siden du ikke vil være der for å forklare hver funksjon for millioner av utviklere som ønsker å bruke det aktuelle programmet.
Kommentarer på flere språk
Fantastisk, nå som vi lærte om kommentarer og hvorfor de er nyttige. La oss utforske hvordan vi kan legge til kommentarer på forskjellige programmeringsspråk.
Enkeltlinjekommentar
// This is a single line comment in C/C++
Flerlinjekommentar
/* This is slightly long multi line comment in C/C++ */
Enkeltlinjekommentar
# This is a single line comment in Python
Flerlinjekommentar
# This is slightly long # multi line comment in Python
Enkeltlinjekommentar
// This is a single line comment in Java
Flerlinjekommentar
/* This is slightly long multi line comment in Java */
Enkeltlinjekommentar
# This is a single line comment in Ruby
Flerlinjekommentar
=begin This is slightly long multi line comment in Ruby =end
Enkeltlinjekommentar
// This is a single line comment in Golang
Flerlinjekommentar
/* This is slightly long multi line comment in Golang */
Enkeltlinjekommentar
– – This is a single line comment in Haskell
Flerlinjekommentar
{- This is slightly long
multi line comment in Haskell -}
Enkeltlinjekommentar
// This is a single line comment in Rust
Flerlinjekommentar
/* This is slightly long multi line comment in Rust */
Enkeltlinjekommentar
<!-- This is a single line comment in HTML -->
Flerlinjekommentar
<!-- This is slightly long multi line comment in HTML -->
Enkeltlinjekommentar
/* This is a single line comment in CSS */
Flerlinjekommentar
/* This is slightly long multi line comment in CSS */
Enkeltlinjekommentar
// This is a single line comment in Javascript
Flerlinjekommentar
/* This is slightly long multi line comment in Javascript */
Enkeltlinjekommentar
# This is a single line comment in R programming language
Flerlinjekommentar
R støtter ikke kommentarer med flere linjer.
Enkeltlinjekommentar
% This is a single line comment in Erlang
Flerlinjekommentar
R støtter ikke kommentarer med flere linjer.
Enkeltlinjekommentar
// This is a single line comment in PHP
Flerlinjekommentar
/* This is slightly long multi line comment in PHP */
Enkeltlinjekommentar
# This is a single line comment in Perl
Flerlinjekommentar
=begin This is slightly long multi line comment in Perl =end
Enkeltlinjekommentar
// This is a single line comment in Kotlin
Flerlinjekommentar
/* This is slightly long multi line comment in Kotlin */
Konklusjon
Opplæringen dekket grunnleggende om kommentarer og 2 vanlige typer – Single og Multi-line. Jeg prøvde også å dekke hvorfor kommentarer er nyttige, og man bør skrive dem når det trengs. Jeg håper du har lært noe nytt!
Fortsett å utforske. Fortsett å lære! 👨💻