У цій статті ви дізнаєтесь про коментарі Котліна, а також чому і як ними користуватися.
У програмуванні коментарі - це частина програми, призначена для вас та ваших колег-програмістів для розуміння коду. Вони повністю ігноруються компілятором Kotlin (Kompiler).
Подібно до Java, у Котліні є два типи коментарів
/*… *///… .
Традиційний коментар / *… * /
Це багаторядковий коментар, який може охоплювати кілька рядків. Компілятор 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 fun main (args: Array) (println ("Hello, World!") // виводить Hello, World! На екран)
Програма вище містить два коментарі до кінця рядка:
// Котлінська програма Hello World
і
// виводи Привіт, Світе! на екрані
Правильно використовуйте коментарі
Коментарі не повинні замінювати спосіб пояснення погано написаного коду англійською мовою. Напишіть добре структурований і читабельний код, а потім використовуйте коментарі.
Деякі вважають, що код повинен бути самодокументованим, а коментарі - мізерними. Однак я повинен з цим повністю не погодитися (це моя особиста думка). Немає нічого поганого у використанні коментарів для пояснення складних алгоритмів, регулярних виразів або сценаріїв, коли ви вибрали одну техніку над іншою (для подальшого використання) для вирішення проблеми.
У більшості випадків використовуйте коментарі, щоб пояснити "чому", а не "як", і ви готові піти.
