I denne artikel lærer du om Kotlin-kommentarer, og hvorfor og hvordan man bruger dem.
Ved programmering er kommentarer en del af programmet, der er beregnet til dig og dine medprogrammerere til at forstå koden. De ignoreres fuldstændigt af Kotlin-kompilatoren (Kompiler).
Ligesom Java er der to typer kommentarer i Kotlin
/*… *///… .
Traditionel kommentar / *… * /
Dette er en kommentar på flere linjer, der kan spænde over flere linjer. Kotlin-kompilatoren ignorerer alt fra /*til */. For eksempel,
/* This is a multi-line comment. * The problem prints "Hello, World!" to the standard output. */ fun main(args: Array) ( println("Hello, World!") )
Traditionskommentaren bruges også til at dokumentere Kotlin-kode (KDoc) med lidt variation. KDoc-kommentarerne starter med /**og slutter med */.
Slut på linjekommentar //
Compileren ignorerer alt fra //slutningen af linjen. For eksempel,
// Kotlin Hello World Program sjov hoved (args: Array) (println ("Hello, World!") // udsender Hello, World! På skærmen)
Ovenstående program indeholder to kommentarer i slutningen af linjen:
// Kotlin Hello World Program
og
// output Hej, Verden! på skærmen
Brug kommentarer på den rigtige måde
Kommentarer bør ikke erstatte en måde at forklare dårligt skrevet kode på engelsk på. Skriv velstruktureret og læsbar kode, og brug derefter kommentarer.
Nogle mener, at kode skal være selvdokumenterende, og kommentarer skal være knappe. Jeg er dog helt uenig i det (det er min personlige mening). Der er intet galt med at bruge kommentarer til at forklare komplekse algoritmer, regex eller scenarier, hvor du har valgt en teknik frem for andre (til fremtidig reference) for at løse problemet.
I de fleste tilfælde skal du bruge kommentarer til at forklare 'hvorfor' i stedet for 'hvordan' og du er god til at gå.
