Låt oss undersöka vad kommentarer i programmering är och varför de spelar en avgörande roll.
Vi kommer även att beröra två vanliga typer av kommentarer, samt illustrera hur de skrivs i 15 olika programmeringsspråk.
Vad innebär kommentarer i programmeringssammanhang?
Enkelt uttryckt är kommentarer textsegment som inte visas för slutanvändare, utan är avsedda som referens för de som skriver koden.
Mer formellt kan man säga att en kommentar utgör en beskrivning av ett program, framställd på ett sätt som gör den lätt att läsa och förstå. Dessa används typiskt där ytterligare förtydliganden behövs för den utvecklare som granskar koden. På detta sätt bidrar de till att förbättra kodens läsbarhet, vilket minskar tiden och kommunikationen som annars skulle krävas för att förmedla kunskap.
Kompilatorn eller tolken ignorerar helt enkelt kommentarerna i koden, vilket betyder att de inte påverkar programmets slutresultat. Kort sagt, kommentarer är som en enkel, lättbegriplig förklaring av specifika delar av koden.
De vanligaste typerna av kommentarer
De flesta programmeringsspråk har stöd för två typer av kommentarer:
- Enradskommentarer
- Fleradskommentarer/Blockkommentarer
Som namnet antyder är enradskommentarer lämpliga när man behöver lägga till kort text på en enda rad, exempelvis för att beskriva ett särskilt tillstånd eller ett konstant värde. Fleradskommentarer är mer användbara när man har större informationsmängder att lägga till, som en beskrivning av en funktion och hur den används, och liknande.
Det finns även andra typer av kommentarer, som dokumentationskommentarer, men de faller utanför ramen för denna artikel.
Varför är kommentarer viktiga?
”En dator kan förstå kod som skrivs av vem som helst. En bra programmerare däremot skriver kod som människor förstår.” – Martin Fowler
Den största fördelen med att infoga kommentarer är att de ökar läsbarheten och underlättar förståelsen av programmet. Utöver detta finns det flera andra fördelar, som:
- Kommentarer gör det mycket enklare för kollegor och andra utvecklare att förstå logiken utan att behöva läsa igenom omfattande dokumentation.
- De minskar behovet av kommunikation mellan utvecklare när små tveksamheter dyker upp.
- Kompilatorer och tolkar ignorerar kommentarer.
- För programvara med öppen källkod är kommentarer ett måste, eftersom du inte kan vara tillgänglig för att förklara varje funktion för miljontals utvecklare som vill använda programmet.
Kommentarer i olika programmeringsspråk
Nu när vi har förstått vad kommentarer är och varför de är användbara, låt oss undersöka hur vi kan lägga till kommentarer i olika programmeringsspråk.
Enradskommentar
// Detta är en enradskommentar i C/C++
Fleradskommentar
/* Detta är en något längre fleradskommentar i C/C++ */
Enradskommentar
# Detta är en enradskommentar i Python
Fleradskommentar
# Detta är en något längre # fleradskommentar i Python
Enradskommentar
// Detta är en enradskommentar i Java
Fleradskommentar
/* Detta är en något längre fleradskommentar i Java */
Enradskommentar
# Detta är en enradskommentar i Ruby
Fleradskommentar
=begin Detta är en något längre fleradskommentar i Ruby =end
Enradskommentar
// Detta är en enradskommentar i Golang
Fleradskommentar
/* Detta är en något längre fleradskommentar i Golang */
Enradskommentar
-- Detta är en enradskommentar i Haskell
Fleradskommentar
{- Detta är en något längre
fleradskommentar i Haskell -}
Enradskommentar
// Detta är en enradskommentar i Rust
Fleradskommentar
/* Detta är en något längre fleradskommentar i Rust */
Enradskommentar
<!-- Detta är en enradskommentar i HTML -->
Fleradskommentar
<!-- Detta är en något längre fleradskommentar i HTML -->
Enradskommentar
/* Detta är en enradskommentar i CSS */
Fleradskommentar
/* Detta är en något längre fleradskommentar i CSS */
Enradskommentar
// Detta är en enradskommentar i Javascript
Fleradskommentar
/* Detta är en något längre fleradskommentar i Javascript */
Enradskommentar
# Detta är en enradskommentar i R-programmeringsspråket
Fleradskommentar
R stöder inte flerkommentarer.
Enradskommentar
% Detta är en enradskommentar i Erlang
Fleradskommentar
Erlang saknar stöd för flerkommentarer.
Enradskommentar
// Detta är en enradskommentar i PHP
Fleradskommentar
/* Detta är en något längre fleradskommentar i PHP */
Enradskommentar
# Detta är en enradskommentar i Perl
Fleradskommentar
=begin Detta är en något längre fleradskommentar i Perl =end
Enradskommentar
// Detta är en enradskommentar i Kotlin
Fleradskommentar
/* Detta är en något längre fleradskommentar i Kotlin */
Sammanfattning
Den här guiden har gått igenom grunderna för kommentarer, inklusive de två vanligaste typerna – enrads- och fleradskommentarer. Jag har även försökt att förklara varför kommentarer är användbara och när de bör skrivas. Jag hoppas att du har lärt dig något nytt!
Fortsätt att utforska och lära! 👨💻