Карта / Синтаксис и типы / Комментарии и формат

Комментарии и формат

Комментарии — это текст для людей, который Java полностью игнорирует. Два вида:

// однострочный — до конца строки

/*
  многострочный —
  можно растянуть на сколько угодно строк
*/

Хороший комментарий объясняет зачем, а не что — само “что” и так видно из кода:

// ❌ плохо: просто пересказывает код
int x = 5; // x равно 5

// ✅ хорошо: объясняет неочевидную причину
int retries = 5; // больше — таймауты API становятся заметны пользователю

Формат кода. Java не требует отступов для работы (в отличие от Python), но это стандарт читаемости: тело { } — на 4 пробела правее. Имена переменных и методов — camelCase (userName, calculateTotal), классы — PascalCase (UserService).

Копнуть глубже

Javadoc — особый вид комментария для документации, начинается с /**:

/**
 * Считает сумму двух чисел.
 *
 * @param a первое слагаемое
 * @param b второе слагаемое
 * @return сумма a и b
 */
int sum(int a, int b) {
    return a + b;
}

IDE подхватывает Javadoc и показывает его всплывающей подсказкой при наведении на метод — даже не открывая исходник. Теги @param (описание параметра), @return (что возвращает), @throws (какие исключения бросает) — стандартный набор для публичных методов и классов библиотек.

Под капотом

Комментарии полностью вырезаются ещё на этапе компиляции — компилятор удаляет их перед тем, как сгенерировать байт-код. Их вообще нет в .class-файле, и они никак не влияют на размер программы или скорость выполнения — пиши их сколько нужно, это бесплатно.

Исключение — Javadoc-комментарии можно отдельно собрать инструментом javadoc в HTML-документацию, но это отдельный шаг сборки, не часть компиляции в байт-код.

🎤 Закрыл тему, если можешь объяснить:
• два вида комментариев и зачем объяснять "зачем", а не "что";
• что такое Javadoc и для чего нужны теги `@param`/`@return` (если дошёл до 2-го слоя).