Бесплатный курс по Kotlin. Зарегистрируйтесь для отслеживания прогресса →

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

Как и в любом языке, в Kotlin есть комментарии. Они никак не используются кодом и нужны только лишь для того, чтобы другие разработчики могли увидеть ваши пометки. Комментарии в Kotlin очень схожи с комментариями в Java и бывают трёх видов:

Однострочные комментарии начинаются с //. Весь текст, который вы напишете после этих символов, не будет исполняться.

Комментарий может находиться как на отдельной строке:

// For Winterfell!

так и на одной строчке с кодом:

print("Hello!") // For Lannisters!

Блочные комментарии начинаются с /* и заканчиваются на */. Принято каждую строку начинать с символа *, хотя технически это и не обязательно.

/* The night is dark and
   full of terrors. */

Документирующие комментарии, как и в Java, начинаются с /** и заканчиваются на */. В случае документирующих комментариев каждая строка обязательно должна начинаться с символа *.

Документирующие комментарии так же несут дополнительную функцию - они могут быть собраны утилитой KDoc (аналог javadoc) и так же могут быть собраны и приложены в качестве документации к коду.

Задание

Создайте однострочный комментарий с текстом You know nothing, Jon Snow!

Упражнение не проходит проверку — что делать? 😶

Если вы зашли в тупик, то самое время задать вопрос в «Обсуждениях». Как правильно задать вопрос:

  • Обязательно приложите вывод тестов, без него практически невозможно понять что не так, даже если вы покажете свой код. Программисты плохо исполняют код в голове, но по полученной ошибке почти всегда понятно, куда смотреть.
В моей среде код работает, а здесь нет 🤨

Тесты устроены таким образом, что они проверяют решение разными способами и на разных данных. Часто решение работает с одними входными данными, но не работает с другими. Чтобы разобраться с этим моментом, изучите вкладку «Тесты» и внимательно посмотрите на вывод ошибок, в котором есть подсказки.

Мой код отличается от решения учителя 🤔

Это нормально 🙆, в программировании одну задачу можно выполнить множеством способов. Если ваш код прошел проверку, то он соответствует условиям задачи.

В редких случаях бывает, что решение подогнано под тесты, но это видно сразу.

Прочитал урок — ничего не понятно 🙄

Создавать обучающие материалы, понятные для всех без исключения, довольно сложно. Мы очень стараемся, но всегда есть что улучшать. Если вы встретили материал, который вам непонятен, опишите проблему в «Обсуждениях». Идеально, если вы сформулируете непонятные моменты в виде вопросов. Обычно нам нужно несколько дней для внесения правок.

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

Полезное


Нашли ошибку? Есть что добавить? Пулреквесты приветствуются https://github.com/hexlet-basics
Если вы столкнулись с трудностями и не знаете, что делать, задайте вопрос в нашем большом и дружном сообществе