In dit artikel leer je over Kotlin-opmerkingen, en waarom en hoe je ze kunt gebruiken.
Bij het programmeren maken opmerkingen deel uit van het programma dat bedoeld is voor jou en je medeprogrammeurs om de code te begrijpen. Ze worden volledig genegeerd door de Kotlin-compiler (Kompiler).
Net als bij Java zijn er twee soorten opmerkingen in Kotlin
/*… *///… .
Traditionele opmerking / *… * /
Dit is een opmerking met meerdere regels die zich over meerdere regels kan uitstrekken. De Kotlin-compiler negeert alles van /*tot */. Bijvoorbeeld,
/* This is a multi-line comment. * The problem prints "Hello, World!" to the standard output. */ fun main(args: Array) ( println("Hello, World!") )
De traditiecommentaar wordt ook gebruikt voor het documenteren van Kotlin-code (KDoc) met een kleine variatie. Het commentaar van KDoc begint met /**en eindigt met */.
Einde regel commentaar //
De compiler negeert alles vanaf //het einde van de regel. Bijvoorbeeld,
// Kotlin Hello World Program fun main (args: Array) (println ("Hello, World!") // output Hello, World! Op het scherm)
Het bovenstaande programma bevat twee opmerkingen aan het einde van de regel:
// Kotlin Hello World-programma
en
// outputs Hallo wereld! op het scherm
Gebruik opmerkingen op de juiste manier
Opmerkingen mogen geen vervanging zijn voor een manier om slecht geschreven code in het Engels uit te leggen. Schrijf goed gestructureerde en leesbare code en gebruik vervolgens opmerkingen.
Sommigen zijn van mening dat code zelfdocumenterend moet zijn en dat opmerkingen schaars moeten zijn. Ik ben het er echter helemaal niet mee eens (het is mijn persoonlijke mening). Er is niets mis met het gebruik van opmerkingen om complexe algoritmen, regex of scenario's uit te leggen waarin u de ene techniek boven de andere hebt gekozen (voor toekomstige referentie) om het probleem op te lossen.
Gebruik in de meeste gevallen opmerkingen om uit te leggen 'waarom' in plaats van 'hoe' en u bent klaar om te gaan.
