I denne artikkelen vil du lære om Kotlin-kommentarer, og hvorfor og hvordan du bruker dem.
I programmeringen er kommentarer en del av programmet som er ment for deg og dine andre programmerere å forstå koden. De blir fullstendig ignorert av Kotlin-kompilatoren (Kompiler).
Lignende som Java, er det to typer kommentarer i Kotlin
/*… *///… .
Tradisjonell kommentar / *… * /
Dette er en flerlinjekommentar som kan strekke seg 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!") )
Tradisjonskommentaren brukes også til å dokumentere Kotlin-kode (KDoc) med litt variasjon. KDoc-kommentarene starter med /**og slutter med */.
Kommentar på slutten av linjen //
Kompilatoren ignorerer alt fra //slutten av linjen. For eksempel,
// Kotlin Hello World Program fun main (args: Array) (println ("Hello, World!") // gir Hello, World! På skjermen)
Programmet ovenfor inneholder to sluttradkommentarer:
// Kotlin Hello World Program
og
// utganger Hello, World! på skjermen
Bruk kommentarer på riktig måte
Kommentarer skal ikke erstatte en måte å forklare dårlig skrevet kode på engelsk på. Skriv godt strukturert og lesbar kode, og bruk deretter kommentarer.
Noen mener at kode skal være selvdokumenterende, og kommentarer bør være knappe. Imidlertid må jeg være helt uenig i det (det er min personlige mening). Det er ingenting galt med å bruke kommentarer til å forklare komplekse algoritmer, regex eller scenarier der du har valgt en teknikk fremfor andre (for fremtidig referanse) for å løse problemet.
I de fleste tilfeller bruker du kommentarer for å forklare 'hvorfor' i stedet for 'hvordan' og du er god å gå.
