English | 简体中文 | 繁體中文 | Русский язык | Français | Español | Português | Deutsch | 日本語 | 한국어 | Italiano | بالعربية

Основной учебник Kotlin

Kotlin управление потоком

Функции в Kotlin

Строки в Kotlin

Kotlin направленный на объекты (OOP)

Комментарии в Kotlin

В этой статье вы узнаете о комментариях в Kotlin, а также о том, почему и как их использовать.

В программировании комментарии являются частью программы и предназначены для того, чтобы вы и другие программисты могли понять код. Компилятор Kotlin (Kompiler) полностью их игнорирует.

Как и в Java, в Kotlin есть два типа комментариев

  • /* ... */

  • // ....

Традиционные комментарии / * ... * /

Это многострочный комментарий, который может распространяться на несколько строк. Компилятор Kotlin будет игнорировать все содержимое с /* до */.

/* Это многострочный комментарий.
 * Проблема: выводить "Hello, World!" в стандартный вывод.
 */
fun main(args: Array<String>) {
   println("Hello, World!")
}

Традиционные комментарии также используются для записи кода Kotlin (KDoc) и несколько изменены. KDoc комментарии начинаются с / ** и заканчиваются * /.

Комментарии в конце строки //

Компилятор будет игнорировать все содержимое с // до конца строки. Например,

// Программа Hello World на Kotlin
fun main(args: Array<String>) {
   println("Hello, World!")      // Вывод Hello, World! на экран
}

Верхняя программа содержит два строковых комментария в конце строк:

// Программа Hello World на Kotlin

и

// Вывод Hello, World! на экран

Правильное использование комментариев

Комментарии не должны заменять плохой код, написанный на английском языке. Напишите структурированный и читаемый код, а затем используйте комментарии.

В большинстве случаев, комментарии используются для объяснения "почему", а не "как", и этого достаточно.