Selles artiklis saate teada Kotlini kommentaaridest ja nende kasutamise põhjustest.
Programmeerimisel on kommentaarid osa programmist, mis on mõeldud teile ja teie kaasprogrammeerijatele koodi mõistmiseks. Kotlini kompilaator (Kompiler) ignoreerib neid täielikult.
Sarnaselt Java-ga on Kotlinis kahte tüüpi kommentaare
/*… *///… .
Traditsiooniline kommentaar / *… * /
See on mitmerealine kommentaar, mis võib hõlmata mitut rida. Kotlini kompilaator ignoreerib kõike alates /*kuni */. Näiteks,
/* This is a multi-line comment. * The problem prints "Hello, World!" to the standard output. */ fun main(args: Array) ( println("Hello, World!") )
Traditsioonilist kommentaari kasutatakse ka Kotlini koodi (KDoc) dokumenteerimiseks väikese variatsiooniga. KDoci kommentaarid algavad /**ja lõpevad */.
Rea lõppu kommentaar //
Koostaja ignoreerib kõike alates //rea lõpust. Näiteks,
// Kotlini tere maailmaprogrammi lõbus peamine (args: Array) (println ("Tere, maailm!") // väljastab ekraanile tere, maailm!)
Eespool olev programm sisaldab kahte rea lõpus olevat kommentaari:
// Kotlini programm Tere maailm
ja
// väljundid Tere, maailm! ekraanil
Kasutage kommentaare õigesti
Kommentaarid ei tohiks asendada viisi, kuidas seletada halvasti kirjutatud koodi inglise keeles. Kirjutage hästi struktureeritud ja loetav kood ning seejärel kasutage kommentaare.
Mõned usuvad, et kood peaks olema ise dokumenteeriv ja kommentaare peaks olema vähe. Pean aga sellega täielikult nõustuma (see on minu isiklik arvamus). Pole midagi halba, kui kasutate kommentaare keeruliste algoritmide, regexi või stsenaariumide selgitamiseks, kus olete probleemi lahendamiseks valinud ühe tehnika (edaspidi kasutamiseks).
Enamasti kasutage kommentaaride abil selgitust miks mitte, kuidas ja miks on hea minna.
