В этой статье вы узнаете о комментариях 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!") )
Традиционный комментарий также используется для документирования кода Kotlin (KDoc) с небольшими вариациями. Комментарии KDoc начинаются с /**и заканчиваются */.
Конец строки комментария //
Компилятор игнорирует все, начиная //с конца строки. Например,
// Программа Kotlin Hello World fun main (args: Array) (println ("Hello, World!") // выводит Hello, World! На экран)
Программа выше содержит два комментария в конце строки:
// Программа Kotlin Hello World
и
// выводит Hello, World! на экране
Используйте комментарии правильно
Комментарии не должны заменять способ объяснить плохо написанный код на английском языке. Напишите хорошо структурированный и читаемый код, а затем используйте комментарии.
Некоторые считают, что код должен быть самодокументированным, а комментариев должно быть немного. Однако я должен полностью с этим не согласиться (это мое личное мнение). Нет ничего плохого в использовании комментариев для объяснения сложных алгоритмов, регулярных выражений или сценариев, в которых вы выбрали один метод вместо другого (для использования в будущем) для решения проблемы.
В большинстве случаев используйте комментарии, чтобы объяснить «почему», а не «как», и все готово.
