V tomto článku se dozvíte o komentářích Kotlin, proč a jak je používat.
V programování jsou komentáře částí programu určeného pro pochopení kódu pro vás a vaše další programátory. Kompilátor Kotlin (Kompiler) je zcela ignoruje.
Podobně jako Java existují v Kotlinu dva typy komentářů
/*… *///… .
Tradiční komentář / *… * /
Toto je víceřádkový komentář, který může zahrnovat více řádků. Kompilátor Kotlin ignoruje vše od /*do */. Například,
/* This is a multi-line comment. * The problem prints "Hello, World!" to the standard output. */ fun main(args: Array) ( println("Hello, World!") )
Komentář k tradici se také používá k dokumentaci kódu Kotlin (KDoc) s malými obměnami. Komentáře KDoc začínají /**a končí */.
Komentář na konec řádku //
Kompilátor ignoruje vše od //konce řádku. Například,
// Kotlin Hello World Program fun main (args: Array) (println ("Hello, World!") // výstupy Hello, World! Na obrazovce)
Výše uvedený program obsahuje dva komentáře na konci řádku:
// Kotlin Hello World Program
a
// výstupy Hello, World! na obrazovce
Používejte komentáře správným způsobem
Komentáře by neměly nahrazovat způsob, jak vysvětlit špatně napsaný kód v angličtině. Napište dobře strukturovaný a čitelný kód a poté použijte komentáře.
Někteří věří, že kód by měl být samodokumentující a komentářů by mělo být málo. Musím s tím však úplně nesouhlasit (je to můj osobní názor). Není nic špatného na tom, když komentáře použijete k vysvětlení složitých algoritmů, regulárních výrazů nebo scénářů, kde jste k vyřešení problému vybrali jednu techniku před druhou (pro budoucí potřebu).
Ve většině případů používejte komentáře k vysvětlení „proč“ spíše než „jak“ a je dobré jít.
