Коментарі в Java

1. Два види коментарів

Хочеться додати пару слів до сказаного вище.

У Java можна писати не лише команди, але й коментарі до них прямо у коді. Такі коментарі ігноруються компілятором, наче їх і немає. Під час виконання програми всі коментарі пропускаються.

Ось приклад:

public class Home
{
   public static void main (String[] args)
   {
      /*
      Зараз ми виводимо на екран фразу 'Amigo the Best'
      */
      System.out.print("Amigo ");
      System.out.print("the ");
      System.out.print("Best");
   }
}

У коді класу ми написали коментар «Зараз ми виводимо на екран фразу ...». Початок коментаря позначається парою символів /*, а кінець — */. Коли програма буде компілюватися, компілятор пропустить все, що знаходиться між символами /* і */

Усередині коментаря можна написати що завгодно.

Зазвичай у коді пишуть різні коментарі до його неочевидних або складних для розуміння частин. Бувають коментарі на десятки рядків: такі зазвичай пишуть перед методами, описуючи нюанси їх роботи.

Є ще один спосіб написати коментар у коді — за допомогою символів //.

public class Home
{
   public static void main (String[] args)
   {
      System.out.print("Amigo ");
      System.out.print("the "); // ось тут ще один коментар
      System.out.print("Best");
   }
}

При цьому коментарем вважається частина коду, починаючи з пари символів // і до кінця рядка, де вони розташовані. Тобто другої пари символів, які «закривають коментар», немає.

2. Коментарі з життя програмістів

Іноді, до речі, в коді трапляються дуже цікаві коментарі:

// Я не відповідаю за цей код. Мене змусили написати його всупереч моєму бажанню.

// Дорогий, я_з_майбутнього! Будь ласка, прости мене за цей код.

// Якщо я ще раз побачу таке, мені доведеться почати носити на роботу зброю.

// Якщо цю умову коли-небудь буде виконано, будь ласка, повідомте мене за телефоном ххх-ххх-ххх за винагороду.

//
// Дорогий програміст:
//
// Коли ти закінчиш «оптимізувати» цю підпрограму
// і зрозумієш, наскільки великою помилкою було робити це,
// будь ласка, збільши лічильник внизу як попередження
// для наступного хлопця:
//
// кількість_годин_витрачених_тут = 42
//

// Коли я починав це писати, лише Бог і я розуміли, що я роблю. // Зараз залишився лише Бог

// іноді мені здається, що компілятор ігнорує всі мої коментарі

// Я присвячую весь свій код, всю роботу своїй дружині Дарлін, якій // доведеться утримувати мене, наших трьох дітей і собаку, коли // це піде в публіку.

// п'яний, виправити пізніше

// Магія. Не чіпати.

Так, коментарі можуть бути дуже кумедними.