Комментарии

Комментарии - это строки, которые предоставляют информацию читателю, но не выполняются и будут проигнорированы компилятором. Они могут быть созданы двумя различными способами.

Однострочные комментарии

Задаются выражением //.

Пример:

// Это комментарий
println("Hello world") // Всё после `//` будет пропущено

Многострочные комментарии

Задаются выражением /* <Что угодно> */, или:

/* <- начало многострочного коментария
 *
*/ <- Конец многострочного комментария

/* Одна косая черта и звёздочка начинает многострочный комментарий, который завершается звёздочкой и ещё одной косой чертой */
println("Goodbye world!")
/* Вы можете закомментировать всё, что находится между началом и концом,

Это будет проигнорировано компилятором */ runScript()
doSomething(a, b, /* Такие комментарии могут быть где угодно */ c, d, e)

KDoc (JavaDoc)

Задаются выражением:

/** <- начало подсказки
 *
*/ <- Конец подсказки

Пример

/**
 * Какая-то, наверно, очень полезная функция
 *
 * @param a Принимает целое число
 * @param b Принимает Текст
 * @return Возвращает "Целое число | Текст"
 *
 * @author _BENDY659_
*/
fun exampleFunction(a: Int, b: String): String = "$a | $b"

Если програма - умная, то она сможет правильно прочитать такие комментарии и правильно показывать их пользователю.

Блок-теги

// Описание для конкретного параметра //
@param [value] [description]

// Описание для того, что возвращает //
@return [description]

// Можно указать автора //
@author [text]

Из больше, но этих хватит вам :)