В тази статия ще научите за коментарите на Kotlin, както и защо и как да ги използвате.
При програмирането коментарите са част от програмата, предназначена за вас и вашите колеги програмисти, за да разберете кода. Те са напълно игнорирани от компилатора Kotlin (Kompiler).
Подобно на Java, в Kotlin има два вида коментари
/*… *///… .
Традиционен коментар / * … * /
Това е многоредов коментар, който може да обхваща няколко реда. Компилаторът Kotlin игнорира всичко от /*до */. Например,
/* This is a multi-line comment. * The problem prints "Hello, World!" to the standard output. */ fun main(args: Array) ( println("Hello, World!") )
Традиционният коментар се използва и за документиране на котлинския код (KDoc) с малко вариации. Коментарите на KDoc започват с /**и завършват с */.
Коментар в края на реда //
Компилаторът игнорира всичко от //до края на реда. Например,
// Kotlin Hello World Program fun main (args: Array) (println ("Hello, World!") // извежда Hello, World! На екрана)
Програмата по-горе съдържа два коментара в края на реда:
// Kotlin Hello World Program
и
// изходи Здравей, Свят! на екрана
Използвайте коментарите по правилния начин
Коментарите не трябва да заместват начина за обяснение на лошо написания код на английски език. Напишете добре структуриран и четим код и след това използвайте коментари.
Някои смятат, че кодът трябва да се самодокументира, а коментарите да са оскъдни. Трябва обаче да не се съглася с него напълно (Това е моето лично мнение). Няма нищо лошо в използването на коментари за обяснение на сложни алгоритми, регулярни изрази или сценарии, при които сте избрали една техника пред друга (за бъдещи справки), за да разрешите проблема.
В повечето случаи използвайте коментари, за да обясните „защо“, а не „как“ и сте готови.
