Šiame straipsnyje sužinosite apie „Kotlin“ komentarus ir kodėl bei kaip juos naudoti.
Programuojant komentarai yra programos dalis, skirta jums ir kitiems programuotojams suprasti kodą. Jų visiškai nepaiso „Kotlin“ kompiliatorius („Kompiler“).
Panašiai kaip „Java“, „Kotlin“ yra dviejų tipų komentarai
/*… *///… .
Tradicinis komentaras / *… * /
Tai yra kelių eilučių komentaras, galintis apimti kelias eilutes. Kotlin kompiliatorius ignoruoja viską nuo /*iki */. Pavyzdžiui,
/* This is a multi-line comment. * The problem prints "Hello, World!" to the standard output. */ fun main(args: Array) ( println("Hello, World!") )
Tradicinis komentaras taip pat naudojamas dokumentuojant Kotlino kodą (KDoc), šiek tiek varijuojant. KDoc komentarai prasideda /**ir baigiasi */.
Eilutės komentaro pabaiga //
Kompiliatorius ignoruoja viską nuo //eilutės pabaigos. Pavyzdžiui,
// „Kotlin Hello World“ programos linksmas pagrindinis (args: Array) (println („Labas, pasauli!“) // ekrane pateikia „Sveikas, pasauli!“)
Aukščiau pateiktoje programoje yra du eilutės pabaigos komentarai:
// „Kotlin Hello World“ programa
ir
// išėjimai Sveiki, pasauli! ekrane
Naudokite komentarus teisingu keliu
Komentarai neturėtų pakeisti blogai parašyto kodo anglų kalba. Parašykite gerai sukonstruotą ir įskaitomą kodą, tada naudokite komentarus.
Kai kurie mano, kad kodas turėtų būti pats dokumentuojamas, o komentarų turėtų būti mažai. Tačiau turiu su tuo visiškai nesutikti (tai mano asmeninė nuomonė). Nėra nieko blogo, jei naudojate komentarus paaiškindami sudėtingus algoritmus, regex'ą ar scenarijus, kai problemai išspręsti pasirinkote vieną metodiką, o ne kitą (ateityje).
Daugeliu atvejų naudokite komentarus, kad paaiškintumėte „kodėl“, o ne „kaip“, ir jums gera eiti.
