Lad os finde ud af, hvad kommentarer er, og hvorfor de er vigtige i programmering.
Vi dækker også to almindelige typer kommentarer og hvordan man skriver dem på 15 forskellige programmeringssprog.
Indholdsfortegnelse
Hvad er kommentarer i programmering?
Kommentarer i lægmandstermer er stykker tekst, der ikke vil være synlige for slutbrugere og er til reference for folk, der skriver kode.
Lidt mere formelt er En kommentar en beskrivelse af et program om, hvordan det fungerer i et enkelt læsbart format. Disse bruges normalt på steder, hvor der skal gives en vis ekstra klarhed til udvikleren, der læser gennem koden. Således hjælper dette med at forbedre kodelæsbarheden og reducerer tid og kommunikation, der ville være påkrævet for at overføre viden.
Compiler/tolk ignorerer simpelthen kommentarerne i din kode og påvirker derved ikke slutresultatet af dit program. Så i en nøddeskal er kommentarer som en simpel læsbar forklaring på visse stykker kode.
Almindelige typer af kommentarer
De fleste programmeringssprog understøtter 2 typer kommentarer.
- Enkeltlinjekommentar
- Multi-Line Kommentar / Bloker kommentarer
Som navnet antyder, er enkeltlinjekommentarer nyttige, når man skal tilføje lille enkeltlinjetekst, f.eks. en bestemt tilstand, en konstant værdi, der kræver en lille beskrivelse. Hvorimod multi-line fungerer bedre, når vi har en større mængde information, der skal tilføjes som en beskrivelse af en funktion og hvordan man kan bruge den osv.
Der er nogle andre typer kommentarer som Dokumentkommentarer, men det er uden for denne artikels omfang.
Hvorfor skal du tilføje kommentarer?
“Enhver idiot kan skrive kode, som en computer kan forstå. Gode programmører skriver kode, som mennesker kan forstå.” – Martin Fowler
Den største fordel ved at tilføje kommentarer er den forbedrede læsbarhed og bedre forståelse af programmet. Ud over dette inkluderer nogle andre fordele –
- Kommentarer gør det super nemt for dine jævnaldrende og endda andre udviklere at forstå logikken uden at læse lange dokumentationer.
- Reduceret kommunikation mellem udviklere for små tvivlsspørgsmål
- Kommentarer ignoreres af compileren/tolkene.
- For open source-software er disse et must, da du ikke vil være der for at forklare alle funktioner til millioner af udviklere, der ønsker at bruge det pågældende program.
Kommentarer på flere sprog
Fantastisk, nu hvor vi lærte om kommentarer og hvorfor de er nyttige. Lad os undersøge, hvordan vi kan tilføje kommentarer på forskellige programmeringssprog.
Enkeltlinjekommentar
// This is a single line comment in C/C++
Kommentar med flere linjer
/* This is slightly long multi line comment in C/C++ */
Enkeltlinjekommentar
# This is a single line comment in Python
Kommentar med flere linjer
# This is slightly long # multi line comment in Python
Enkeltlinjekommentar
// This is a single line comment in Java
Kommentar med flere linjer
/* This is slightly long multi line comment in Java */
Enkeltlinjekommentar
# This is a single line comment in Ruby
Kommentar med flere linjer
=begin This is slightly long multi line comment in Ruby =end
Enkeltlinjekommentar
// This is a single line comment in Golang
Kommentar med flere linjer
/* This is slightly long multi line comment in Golang */
Enkeltlinjekommentar
– – This is a single line comment in Haskell
Kommentar med flere linjer
{- This is slightly long
multi line comment in Haskell -}
Enkeltlinjekommentar
// This is a single line comment in Rust
Kommentar med flere linjer
/* This is slightly long multi line comment in Rust */
Enkeltlinjekommentar
<!-- This is a single line comment in HTML -->
Kommentar med flere linjer
<!-- This is slightly long multi line comment in HTML -->
Enkeltlinjekommentar
/* This is a single line comment in CSS */
Kommentar med flere linjer
/* This is slightly long multi line comment in CSS */
Enkeltlinjekommentar
// This is a single line comment in Javascript
Kommentar med flere linjer
/* This is slightly long multi line comment in Javascript */
Enkeltlinjekommentar
# This is a single line comment in R programming language
Kommentar med flere linjer
R understøtter ikke kommentarer med flere linjer.
Enkeltlinjekommentar
% This is a single line comment in Erlang
Kommentar med flere linjer
R understøtter ikke kommentarer med flere linjer.
Enkeltlinjekommentar
// This is a single line comment in PHP
Kommentar med flere linjer
/* This is slightly long multi line comment in PHP */
Enkeltlinjekommentar
# This is a single line comment in Perl
Kommentar med flere linjer
=begin This is slightly long multi line comment in Perl =end
Enkeltlinjekommentar
// This is a single line comment in Kotlin
Kommentar med flere linjer
/* This is slightly long multi line comment in Kotlin */
Konklusion
Selvstudiet dækkede grundlæggende om kommentarer og 2 almindelige typer – Enkelt- og Multi-line. Jeg forsøgte også at dække, hvorfor kommentarer er nyttige, og man bør skrive dem, når det er nødvendigt. Jeg håber du har lært noget nyt!
Fortsæt med at udforske. Fortsæt med at lære! 👨💻