Šajā rakstā jūs uzzināsiet par Kotlina komentāriem un to, kāpēc un kā tos izmantot.
Programmēšanā komentāri ir daļa no programmas, kas paredzēta jums un jūsu programmētājiem, lai saprastu kodu. Kotlin kompilators (Kompiler) tos pilnībā ignorē.
Līdzīgi kā Java, Kotlinā ir divu veidu komentāri
/*… *///… .
Tradicionāls komentārs / *… * /
Šis ir daudzrindu komentārs, kas var ietvert vairākas līnijas. Kotlina sastādītājs ignorē visu, sākot no /*līdz */. Piemēram,
/* This is a multi-line comment. * The problem prints "Hello, World!" to the standard output. */ fun main(args: Array) ( println("Hello, World!") )
Tradīcijas komentārs tiek izmantots arī Kotlina koda (KDoc) dokumentēšanai ar nelielām variācijām. KDoc komentāri sākas ar /**un beidzas ar */.
Rindas beigu komentārs //
Sastādītājs ignorē visu, sākot no //rindas beigām. Piemēram,
// Kotlin Hello World Program fun main (args: Array) (println ("Sveika, pasaule!") // ekrānā tiek parādīts sveiks, pasaule!)
Iepriekš minētajā programmā ir divi komentāri rindas beigās:
// Kotlinas Sveika pasaules programma
un
// izejas Sveika, pasaule! uz ekrāna
Izmantojiet komentārus pareizi
Komentāri nedrīkst aizstāt veidu, kā izskaidrot slikti uzrakstītu kodu angļu valodā. Uzrakstiet labi strukturētu un lasāmu kodu un pēc tam izmantojiet komentārus.
Daži uzskata, ka kodam jābūt pašdokumentējošam un komentāriem jābūt ierobežotiem. Tomēr man tam pilnībā jāpiekrīt (tas ir mans personīgais viedoklis). Nav nekas nepareizs, izmantojot komentārus, lai izskaidrotu sarežģītus algoritmus, regulāru izteiksmi vai scenārijus, kur problēmas risināšanai esat izvēlējies vienu paņēmienu, nevis citu (turpmākai izmantošanai).
Vairumā gadījumu izmantojiet komentārus, lai paskaidrotu "kāpēc", nevis "kā", un jums ir labi iet.
