JAVA MEGJEGYZÉSEK

Próbáld ki a GfG Practice-n

A Java-ban a megjegyzések nem végrehajtható utasítások, amelyek magyarázatot adnak a kódra és javítják az olvashatóságot. A fordító figyelmen kívül hagyja őket, és nem befolyásolják a program végrehajtását.

A kód olvashatóságának és karbantarthatóságának javítása.
Hasznos hibakereséshez és logika dokumentálásához.

A Java három fő megjegyzéstípust támogat:

1. Egysoros megjegyzések

Az egysoros megjegyzések egy kódsor megjegyzésére szolgálnak.

Szintaxis:

// Megjegyzések itt (Csak ebben a sorban lévő szöveg számít megjegyzésnek )

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

Kimenet

Single Line Comment Above

2. Többsoros megjegyzések

A többsoros megjegyzések bonyolult kódok vagy módszerek leírására szolgálnak, mivel több egysoros megjegyzés írása unalmas lehet.

/*
Elindul a megjegyzés
folytatja
folytatódik...
A megjegyzés véget ér
*/

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

Kimenet

Multi Line Comments Below

3. Dokumentációs megjegyzések

A dokumentációs megjegyzések külső dokumentáció létrehozására szolgálnak Javadoc használatával. Általában professzionális projektekben használják az osztályok módszereinek és paramétereinek leírására.

Szintaxis:

/**
* Megjegyzés kezdete
* @param param-name leírás
* @return description
*/

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