V tomto článku sa dozviete o komentároch Kotlin, o tom, prečo a ako ich používať.
Pri programovaní sú komentáre časťou programu určeného pre vás a vašich programátorov na pochopenie kódu. Sú úplne ignorované prekladačom Kotlin (Kompiler).
Podobné ako Java existujú v Kotline dva typy komentárov
/*… *///… .
Tradičný komentár / *… * /
Toto je viacriadkový komentár, ktorý môže obsahovať viac riadkov. Kompilátor Kotlin ignoruje všetko od /*do */. Napríklad,
/* This is a multi-line comment. * The problem prints "Hello, World!" to the standard output. */ fun main(args: Array) ( println("Hello, World!") )
Komentár k tradícii sa tiež používa na dokumentáciu Kotlinovho kódu (KDoc) s malými obmenami. Komentáre KDoc začínajú /**a končia */.
Koniec komentára //
Kompilátor ignoruje všetko od //konca riadku. Napríklad,
// Kotlin Hello World Program fun main (args: Array) (println ("Hello, World!") // výstupy Hello, World! Na obrazovke)
Vyššie uvedený program obsahuje dva komentáre na konci riadku:
// Kotlin Hello World Program
a
// výstupy Hello, World! na obrazovke
Používajte Komentáre správnym spôsobom
Komentáre by nemali byť náhradou za spôsob vysvetlenia zle napísaného kódu v angličtine. Napíšte dobre štruktúrovaný a čitateľný kód a potom použite komentáre.
Niektorí sa domnievajú, že kódex by mal mať vlastnú dokumentáciu a komentárov by malo byť málo. Musím s tým však úplne nesúhlasiť (je to môj osobný názor). Nie je nič zlé na tom, že pomocou komentárov vysvetlíte zložité algoritmy, regulárne výrazy alebo scenáre, pri ktorých ste na vyriešenie problému vybrali jednu techniku nad druhou (pre budúce použitie).
Vo väčšine prípadov pomocou komentárov vysvetlite radšej „prečo“ ako „ako“ a je dobré ísť.
