Коментарі Java

Коментарі Java
Спробуйте на GfG Practice

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

  • Покращте читабельність коду та зручність обслуговування.
  • Корисно для налагодження та документування логіки.

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

1. Однорядкові коментарі

Однорядкові коментарі використовуються для коментування одного рядка коду.

Синтаксис:   

// Коментарі тут (лише текст у цьому рядку вважається коментарем)

Java
   // Java program to show single line comments   class   GFG   {      public     static     void     main  (  String     args  []  )      {         // Single line comment here      System  .  out  .  println  (  'Single Line Comment Above'  );         }   }   

Вихід
Single Line Comment Above  

2. Багаторядкові коментарі

Багаторядкові коментарі використовуються для опису складного коду або методів, оскільки написання кількох однорядкових коментарів може бути виснажливим.

/*
Починається коментар
продовжується
продовжує...
Коментар закінчується
*/

Java
   class   GFG   {      public     static     void     main  (  String     args  []  )      {         System  .  out  .  println  (  'Multi Line Comments Below'  );          /* Comment line 1    Comment line 2     Comment line 3    */      }   }   

Вихід
Multi Line Comments Below  

3. Коментарі до документації

Коментарі до документації використовуються для створення зовнішньої документації за допомогою Javadoc. Вони зазвичай використовуються в професійних проектах для опису методів і параметрів класів.

Синтаксис:   

/**
* Початок коментаря
* @param опис імені параметра
* Опис @return
*/

Java
   /**    *     * Calculates the average of three integers.    * @author Pratik Agarwal    * @version 1.0    * @since 2017-02-18    */   public     class   FindAvg  {      /**    * Finds average of three integers.    * @param numA First parameter    * @param numB Second parameter    * @param numC Third parameter    * @return Average of numA numB and numC    */      public     int     findAvg  (  int     numA       int     numB       int     numC  )      {      return     (  numA     +     numB     +     numC  )     /     3  ;      }      /**    * Main method which uses findAvg method    * @param args Unused    */      public     static     void     main  (  String     args  []  ){      FindAvg     obj     =     new     FindAvg  ();      int     avg     =     obj  .  findAvg  (  10       20       30  );      System  .  out  .  println  (  'Average of 10 20 and 30 is: '      +     avg  );      }   }   

Вихід
Average of 10 20 and 30 is: 20  

Пов'язана стаття: Інструмент JavaDoc


Створіть вікторину