Låt oss ta reda på vad kommentarer är och varför de är viktiga i programmering.
Vi tar också upp två vanliga typer av kommentarer och hur man skriver dem på 15 olika programmeringsspråk.
Innehållsförteckning
Vad är kommentarer i programmering?
Kommentarer i lekmannatermer är bitar av text som inte kommer att vara synliga för slutanvändare och är till referens för personer som skriver kod.
Lite mer formellt är En kommentar en beskrivning av ett program om hur det fungerar i ett enkelt läsbart format. Dessa används vanligtvis på platser där viss ytterligare klarhet behöver ges till utvecklaren som läser igenom koden. På så sätt hjälper detta till att förbättra kodläsbarheten och minskar tid och kommunikation som skulle krävas för att överföra kunskap.
Kompilator/tolk ignorerar helt enkelt kommentarerna i din kod och påverkar därmed inte slutresultatet av ditt program. Så i ett nötskal är kommentarer som en enkel läsbar förklaring för vissa delar av kod.
Vanliga typer av kommentarer
De flesta programmeringsspråk stöder 2 typer av kommentarer.
- En rad kommentar
- Flerradskommentar / Blockera kommentarer
Som namnet antyder är enradskommentarer användbara när man behöver lägga till liten enradstext, t.ex. ett särskilt tillstånd, ett konstant värde som behöver en liten beskrivning. Medan multi-line fungerar bättre när vi har en större mängd information som ska läggas till som en beskrivning av en funktion och hur man kan använda den, etc.
Det finns några andra typer av kommentarer som dokumentkommentarer men det faller utanför den här artikelns omfattning.
Varför ska du lägga till kommentarer?
”Varje dåre kan skriva kod som en dator kan förstå. Bra programmerare skriver kod som människor kan förstå.” – Martin Fowler
Den stora fördelen med att lägga till kommentarer är den förbättrade läsbarheten och bättre förståelse för programmet. Förutom detta inkluderar några andra fördelar –
- Kommentarer gör det superenkelt för dina kamrater och även andra utvecklare att förstå logiken utan att läsa igenom lång dokumentation.
- Minskad kommunikation mellan utvecklare för små tvivel
- Kommentarer ignoreras av kompilatorn/tolkarna.
- För programvara med öppen källkod är dessa ett måste eftersom du inte kommer att vara där för att förklara varje funktion för miljontals utvecklare som vill använda just det programmet.
Kommentarer på flera språk
Fantastiskt, nu när vi lärde oss om kommentarer och varför de är användbara. Låt oss utforska hur vi kan lägga till kommentarer på olika programmeringsspråk.
En rad kommentar
// This is a single line comment in C/C++
Flerlinjekommentar
/* This is slightly long multi line comment in C/C++ */
En rad kommentar
# This is a single line comment in Python
Flerlinjekommentar
# This is slightly long # multi line comment in Python
En rad kommentar
// This is a single line comment in Java
Flerlinjekommentar
/* This is slightly long multi line comment in Java */
En rad kommentar
# This is a single line comment in Ruby
Flerlinjekommentar
=begin This is slightly long multi line comment in Ruby =end
En rad kommentar
// This is a single line comment in Golang
Flerlinjekommentar
/* This is slightly long multi line comment in Golang */
En rad kommentar
– – This is a single line comment in Haskell
Flerlinjekommentar
{- This is slightly long
multi line comment in Haskell -}
En rad kommentar
// This is a single line comment in Rust
Flerlinjekommentar
/* This is slightly long multi line comment in Rust */
En rad kommentar
<!-- This is a single line comment in HTML -->
Flerlinjekommentar
<!-- This is slightly long multi line comment in HTML -->
En rad kommentar
/* This is a single line comment in CSS */
Flerlinjekommentar
/* This is slightly long multi line comment in CSS */
En rad kommentar
// This is a single line comment in Javascript
Flerlinjekommentar
/* This is slightly long multi line comment in Javascript */
En rad kommentar
# This is a single line comment in R programming language
Flerlinjekommentar
R stöder inte kommentarer med flera rader.
En rad kommentar
% This is a single line comment in Erlang
Flerlinjekommentar
R stöder inte kommentarer med flera rader.
En rad kommentar
// This is a single line comment in PHP
Flerlinjekommentar
/* This is slightly long multi line comment in PHP */
En rad kommentar
# This is a single line comment in Perl
Flerlinjekommentar
=begin This is slightly long multi line comment in Perl =end
En rad kommentar
// This is a single line comment in Kotlin
Flerlinjekommentar
/* This is slightly long multi line comment in Kotlin */
Slutsats
Handledningen täckte grunderna om kommentarer och 2 vanliga typer – enkel och flerrad. Jag försökte också täcka varför kommentarer är användbara och man bör skriva dem när det behövs. Jag hoppas att du lärde dig något nytt!
Fortsätt utforska. Fortsätt lära! 👨💻