KOMENTÁŘE JAVA

Zkuste to na GfG Practice

V Javě jsou komentáře nespustitelné příkazy, které vysvětlují kód a zlepšují čitelnost. Překladač je ignoruje a neovlivňují provádění programu.

Vylepšete čitelnost a udržovatelnost kódu.
Užitečné pro ladění a dokumentaci logiky.

Java podporuje tři hlavní typy komentářů:

1. Jednořádkové komentáře

Jednořádkové komentáře se používají ke komentování jednoho řádku kódu.

Syntax:

// Komentáře zde (pouze text v tomto řádku je považován za komentář)

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'  );         }   }

Výstup

Single Line Comment Above

2. Víceřádkové komentáře

Víceřádkové komentáře se používají k popisu složitého kódu nebo metod, protože psaní více jednořádkových komentářů může být únavné.

/*
Komentář se spustí
pokračuje
pokračuje...
Komentář končí
*/

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    */      }   }

Výstup

Multi Line Comments Below

3. Poznámky k dokumentaci

Komentáře k dokumentaci se používají ke generování externí dokumentace pomocí Javadoc. Obecně se používají v profesionálních projektech k popisu metod a parametrů tříd.

Syntax:

/**
* Začátek komentáře
* @param popis názvu parametru
* popis @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  );      }   }