Java-kommentarer

Java-kommentarer
Prova det på GfG Practice

I Java är kommentarer icke-körbara satser som förklarar kod och förbättrar läsbarheten. De ignoreras av kompilatorn och påverkar inte programexekveringen.

  • Förbättra kodläsbarhet och underhållbarhet.
  • Användbar för att felsöka och dokumentera logik.

Java stöder tre huvudtyper av kommentarer:

1. Kommentarer på en rad

Enradskommentarer används för att kommentera en kodrad.

Syntax:   

// Kommentarer här (Endast text på denna rad betraktas som kommentar)

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

Produktion
Single Line Comment Above  

2. Flerlinjekommentarer

Flerradiga kommentarer används för att beskriva komplex kod eller metoder eftersom det kan vara tråkigt att skriva flera enradiga kommentarer.

/*
Kommentar börjar
fortsätter
fortsätter...
Kommentaren slutar
*/

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

Produktion
Multi Line Comments Below  

3. Dokumentationskommentarer

Dokumentationskommentarer används för att generera extern dokumentation med Javadoc. De används vanligtvis i professionella projekt för att beskriva klassmetoder och parametrar.

Syntax:   

/**
* Kommentera start
* @param param-namn beskrivning
* @returbeskrivning
*/

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

Produktion
Average of 10 20 and 30 is: 20  

Relaterad artikel: JavaDoc-verktyg


Skapa frågesport