Компилятор Kotlin генерирует байт-код или исполняемый код из вашего исходного кода. Для этого он использует подробный набор правил, о которых вы узнаете в данном курсе. Иногда эти детали не показывают общую картину того, почему код написан определенным образом или даже какую проблему вы решаете. Чтобы этого не произошло, желательно задокументировать то, что вы написали, чтобы другой человек смог разобраться в вашей работе. В конце концов, этим человеком можете стать вы в будущем.
Kotlin, как и большинство других языков программирования, позволяет документировать код с помощью так называемых комментариев. Это позволяет вам писать любой текст рядом с вашим кодом, и данный текст игнорируется компилятором.
Первый способ написать комментарий на Kotlin выглядит следующим образом:
| 1 | // Это комментарий. Он не выполняется. |
Это комментарий в одну строку.
Таким образом, можно написать несколько комментариев с новой строки:
| 1 2 | // Это тоже комментарий. // На несколько строчек. |
Однако есть более удобный способ написания многострочных комментариев в Kotlin, к примеру:
| 1 2 3 4 | /* Это также комментарий. На много.. много... много строчек. */ |
Это многострочный комментарий. Он начинается с /* и заканчивается */. Все просто!
В Kotlin также можно создавать вложенные комментарии:
| 1 2 3 4 5 6 7 8 9 | /* Это комментарий. /* И внутри него находится другой комментарий. */ Вернемся к первому. */ |
Это может показаться не особенно интересным, но если вы работали с другими языками программирования, вы должны понимать важность правильного использования комментариев.
Многие языки не позволяют писать вложенные комментарии, так как когда язык видит первый */, он думает, что вы закрываете первый комментарий. Вы должны использовать комментарии там, где это необходимо — чтобы задокументировать код, объяснить свои рассуждения или просто оставить шутки для коллег.