V tem članku boste izvedeli več o komentarjih Kotlin ter o tem, zakaj in kako jih uporabiti.
Pri programiranju so komentarji del programa, namenjen vam in vašim kolegom programerjem za razumevanje kode. Prevajalnik Kotlin (Kompiler) jih popolnoma prezre.
Podobno kot Java obstaja tudi v Kotlinu dve vrsti komentarjev
/*… *///… .
Tradicionalni komentar / * … * /
To je večvrstični komentar, ki lahko obsega več vrstic. Prevajalnik Kotlin ignorira vse od /*do */. Na primer
/* This is a multi-line comment. * The problem prints "Hello, World!" to the standard output. */ fun main(args: Array) ( println("Hello, World!") )
Komentar tradicije se uporablja tudi za dokumentiranje Kotlinove kode (KDoc) z malo različicami. Komentarji KDoc se začnejo z /**in končajo z */.
Komentar konca vrstice //
Prevajalnik prezre vse od //do konca vrstice. Na primer
// Kotlin Hello World Program zabavna glavna (args: Array) (println ("Hello, World!") // na zaslonu prikaže Hello, World!
Zgornji program vsebuje dva komentarja na koncu vrstice:
// Kotlinov program Hello World
in
// izhodov Hello, World! na zaslonu
Uporabite komentarje na pravi način
Komentarji ne bi smeli nadomestiti načina razlage slabo napisane kode v angleščini. Napišite dobro strukturirano in berljivo kodo in nato uporabite komentarje.
Nekateri menijo, da bi se morala koda samo dokumentirati, komentarji pa bi morali biti redki. Vendar se moram s tem popolnoma ne strinjati (to je moje osebno mnenje). Nič ni narobe z uporabo komentarjev za razlago kompleksnih algoritmov, regularnih izrazov ali scenarijev, kjer ste za rešitev težave izbrali eno tehniko kot drugo (za poznejšo uporabo).
V večini primerov uporabite komentarje, da razložite "zakaj" in ne "kako".
