KOMENTARZE JAVY

Wypróbuj w praktyce GfG

W Javie komentarze są niewykonalnymi instrukcjami, które wyjaśniają kod i poprawiają czytelność. Są one ignorowane przez kompilator i nie wpływają na wykonanie programu.

Zwiększ czytelność kodu i łatwość konserwacji.
Przydatne do debugowania i dokumentowania logiki.

Java obsługuje trzy główne typy komentarzy:

1. Komentarze jednowierszowe

Komentarze jednowierszowe służą do komentowania jednej linii kodu.

Składnia:

// Tutaj komentarze (Tylko tekst w tej linii jest uważany za komentarz)

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

Wyjście

Single Line Comment Above

2. Komentarze wielowierszowe

Komentarze wielowierszowe służą do opisywania złożonego kodu lub metod, ponieważ pisanie wielu komentarzy jednowierszowych może być żmudne.

/*
Rozpoczyna się komentarz
kontynuuje
kontynuuje...
Komentarz się kończy
*/

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

Wyjście

Multi Line Comments Below

3. Komentarze do dokumentacji

Komentarze do dokumentacji służą do generowania dokumentacji zewnętrznej przy użyciu Javadoc. Są one powszechnie używane w profesjonalnych projektach do opisu metod i parametrów klas.

Składnia:

/**
* Początek komentarza
* @param nazwa-parametru opis
* Opis @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  );      }   }