Коментарі в 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
//

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

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

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

// п'яний, виправити згодом

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

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