U ovom ćete članku naučiti o komentarima Kotlina, te zašto i kako ih koristiti.
U programiranju, komentari su dio programa namijenjen vama i vašim kolegama programerima da biste razumjeli kôd. U potpunosti ih ignorira kotlinov kompajler (Kompiler).
Slično kao i Java, u Kotlinu postoje dvije vrste komentara
/*… *///… .
Tradicionalni komentar / * … * /
Ovo je višeredni komentar koji može obuhvaćati više redaka. Kompajler Kotlin ignorira sve od /*do */. Na primjer,
/* This is a multi-line comment. * The problem prints "Hello, World!" to the standard output. */ fun main(args: Array) ( println("Hello, World!") )
Komentar tradicije također se koristi za dokumentiranje Kotlinovog koda (KDoc) s malim varijacijama. KDoc komentari započinju s /**i završavaju s */.
Komentar na kraj retka //
Prevoditelj ignorira sve od //do kraja retka. Na primjer,
// Kotlin Hello World Program zabava glavna (args: Array) (println ("Hello, World!") // na ekranu prikazuje Hello, World!
Gornji program sadrži dva komentara na kraju retka:
// Kotlinov program Hello World
i
// izlazi Hello, World! na ekranu
Koristite komentare na pravi način
Komentari ne bi trebali biti zamjena za način objašnjavanja loše napisanog koda na engleskom jeziku. Napišite dobro strukturiran i čitljiv kod, a zatim upotrijebite komentare.
Neki smatraju da bi se kôd trebao sam dokumentirati, a komentari oskudni. Međutim, moram se u potpunosti ne složiti s tim (to je moje osobno mišljenje). Nema ništa loše u korištenju komentara za objašnjavanje složenih algoritama, regularnih izraza ili scenarija u kojima ste za rješavanje problema odabrali jednu od drugih tehnika (za buduću referencu).
U većini slučajeva koristite komentare da biste objasnili "zašto", a ne "kako", i spremni ste za to.
