Комментарии в языке Java — как и в большинстве других языков программирования, символы, которые игнорируются при выполнении программы. Таким образом, в программу можно добавлять столько комментариев, сколько потребуется, не опасаясь увеличить ее объем. Комментарии используются для описания тонкостей работы конкретного блока кода, метода или класса. Также можно использовать их, если хочется оставить сообщения для программистов, которые в будущем будут работать с этим кодом. Ну или же для собственных заметок.
Способы выделения комментариев
В языке Java есть два способа выделения комментариев в тексте.
Комментарий реализации (комментарий кода)
Комментирование строки
Это самый часто используемый тип комментариев. Чтобы написать такой комментарий, нужно использовать две косые черты //. При этом комментарий начинается сразу за символами // и продолжается до конца строки.
System.out.println("Hello, Java world!");
// наш комментарий
Комментирование блока текста
Если нужны более длинные комментарии, можно каждую строку начинать символами. Хотя более удобно ограничивать блоки комментариев разделителями /* и */.
/*
Пример простой программы на Java
*/
public class SampleProgram
{
public static void main (String [] args)
{
System.out.println("Hello, Java world!");
}
}
Не следует забывать, что комментарии, выделяемые символами /* и */ в языке Java не могут быть вложенными. Это значит, что фрагмент кода нельзя отключить, просто окружив его /* и */, поскольку отключаемый код сам может содержать разделители /* и */.
Документирующий комментарий
Для документирования методов, переменных или классов используется особый способ выделения текста. Делается это с помощью /** и */. При этом каждая строка комментируемого текста начинается с *.Если документируется метод, принято описывать его аргументы и возвращаемое значение.
/**
* Метод возвращает максимальное значение
* из трех переданных аргументов
* @param a - первый параметр
* @param b - второй параметр
* @param c - третий параметр
* @return - максимальный из параметров
*/
public int max(int a, int b, int c) {
return Math.max(Math.max(a, b), c);
}
В прошлом Андрей руководил собственной web-студией в Киеве и работал фронтенд-разработчиком в JavaRush, а сейчас пишет код для нем ...
[Читать полную биографию]
Всем привет! Приглашаю на мой тг канал "Путь к Java: Дневник разработчика"!
На канале вы найдете:
- Мои ежедневные отчеты о прогрессе в обучении
- Полезные материалы по Java
- Есть чат, где вы можете делиться друг с другом своим прогрессом, а также обсуждать любые вопросы, касательно обучения и не только
Канал был создан недавно, но я уверен, что мы быстро сформируем сообщество единомышленников и будем приятно и с пользой проводить время.
Присоединяйтесь! Путь к Java: Дневник разработчика
Написано что код не может быть отключен вот так, почему ведь символы должны сделать из него комментарий, как так?
/* "код"
код
код
*/
Было бы очень неплохо если бы это сразу обьяснили в лекции
Потому что внутри отключаемого куска кода уже может быть комментарий, а значит комбинация выйдет /* код /* комментарий */ код */, а так не работает. Ну если я правильно понял :)
Код можно так отключить. Но с большими кусками лучше так не делать.
Потому, что кусок, что ты хочешь убрать, может тоже содержать коммент. Тогда всё после закрытия комментария (*/) будет обрабатываться:
/* ты поставил знак коммента
код
код
/* не твой коммент
*/ не твой коммент (закрывает и твой коммент)
код - ты хотел его отключить своим комментом
код - но эти строки теперь работают, т.к. твой коммент закрылся выше.
*/ - тут ты хотел закрыть коммент
Спасибо. Я подписался на ваш премиум, чтобы реализовать задуманное для проекта Virtual Staging. Надеюсь, это поможет и можно будет запустить крутой проект с помощью ваших курсов!
public int max(int a, int b, int c) {
return Math.max(Math.max(a, b), c);
Вопрос про скобку после «b»?!
Я уже понял, что закрывающих скобок должно быть столько же, сколько открывающий. А две скобки после «с» не может быть? Или у нее другое значение?
Посмотрите внимательнее. Сперва идёт выбор наибольшего из a и b : Math.max(a, b).
А затем идёт выбор наибольшего из предыдущего результата Math.max(a, b) и с : Math.max(Math.max(a, b), c).
Чтобы было легче понять, можно расписать код так:
int d = Math.max(a, b)
return Math.max(d, c);
Привет! Поясните, это для того, чтобы писать в комментарии НЕ текст?
Для документирования методов, переменных или классов используется особый способ выделения текста. Делается это с помощью /** и */. При этом каждая строка комментируемого текста начинается с *.Если документируется метод, принято описывать его аргументы и возвращаемое значение.
Не следует забывать, что комментарии, выделяемые символами /* и */ в языке Java не могут быть вложенными. Это значит, что фрагмент кода нельзя отключить, просто окружив его /* и */, поскольку отключаемый код сам может содержать разделители /* и */.
Объясните, пожалуйста, что же это значит )
значит, что если ты выбедилишь написанные код символами /* и*/ он все равно будет работать, а вот если ты перед кодом поставишь символы // то после них код будет считаться коментарием
Если пытаться обернуть часть кода блочным комментарием, в котором также будет присутствовать блочный комментарий, то получим синтаксическую ошибку. Т.е. такая конструкция:
/* Хочу закомментировать часть кода
код
/* Блочный комментарий к коду*/
код
*/
- "ее"
- "объем"
- "/*
Пример простой программы на Java
*/
public class SampleProgram
{
public static void main (String [] args)
{
System.out.println("Hello, Java world!");
}
}" - как насчёт сделать нормальные отступы?
- "трех"
- "еще"
Ау! Забей на букву "ё" ее никто не пишет, даже встроенный правописатель в ворде не видит за ошибку слова с буквой "ё" замененной на "е" как ошибку. Смирись - это новые тенденции правописания, она уходит с обихода как и твердый знак.
Ё - не уходит, а возвращается. И это отличная новость. Ибо она ощутимо меняет не только звучание, но и смысл написанного. Незаслуженно игнорируемая полноценная буква наконец-то вновь становиться по праву важной частью Русского языка. А упрощения и искажения "великого и могучего" пусть остаются уделом тинейджеров в их "падонском" языке и не выходят за его рамки. ) Аминь.
ПЕРЕЙДИТЕ В ПОЛНУЮ ВЕРСИЮ