Коментарі Java: навіщо і як ними користуватися?

У цьому підручнику ви дізнаєтесь про коментарі Java, чому ми їх використовуємо та як правильно використовувати коментарі.

У комп'ютерному програмуванні коментарі - це частина програми, яка повністю ігнорується компіляторами Java. Вони в основному використовуються для того, щоб допомогти програмістам зрозуміти код. Наприклад,

 // declare and initialize two variables int a =1; int b = 3; // print the output System.out.println("This is output"); 

Тут ми використали такі коментарі,

  • оголосити та ініціалізувати дві змінні
  • роздрукувати вихідні дані

Типи коментарів на Java

У Java є два типи коментарів:

  • однорядковий коментар
  • багаторядковий коментар

Однорядковий коментар

Однорядковий коментар починається і закінчується в одному рядку. Щоб написати однорядковий коментар, ми можемо використовувати //символ. Наприклад,

 // "Hello, World!" program example class Main ( public static void main(String() args) ( ( // prints "Hello, World!" System.out.println("Hello, World!"); ) ) 

Вихід :

 Привіт Світ! 

Тут ми використали два однорядкові коментарі:

  • "Привіт Світ!" приклад програми
  • друкує "Привіт Світ!"

Компілятор Java ігнорує все, починаючи //з кінця рядка. Отже, він також відомий як коментар Кінець рядка .

Багаторядковий коментар

Коли ми хочемо писати коментарі у кілька рядків, ми можемо використовувати багаторядковий коментар. Для написання багаторядкових коментарів ми можемо використовувати символ / * …. * /. Наприклад,

 /* This is an example of multi-line comment. * The program prints "Hello, World!" to the standard output. */ class HelloWorld ( public static void main(String() args) ( ( System.out.println("Hello, World!"); ) ) 

Вихід :

 Привіт Світ! 

Тут ми використали багаторядковий коментар:

 /* This is an example of multi-line comment. * The program prints "Hello, World!" to the standard output. */ 

Цей тип коментарів також відомий як традиційний коментар . У цьому типі коментарів компілятор Java ігнорує все від /*до */.

Правильно використовуйте коментарі

Потрібно завжди враховувати те, що коментарі не повинні замінювати спосіб пояснення погано написаного коду англійською мовою. Ви завжди повинні писати добре структурований і зрозумілий код. А потім використовуйте коментарі.

Деякі вважають, що код повинен бути самоописом, а коментарі слід використовувати рідко. Однак, на мою особисту думку, у використанні коментарів немає нічого поганого. Ми можемо використовувати коментарі для пояснення складних алгоритмів, регулярних виразів або сценаріїв, коли нам потрібно вибрати один із методів для вирішення проблем.

Примітка : У більшості випадків завжди використовуйте коментарі, щоб пояснити " чому ", а не " як ", і ви готові піти.

Цікаві статті...