JAVA KOMMENTIT

Kokeile sitä GfG Practicessa

Javassa kommentit ovat ei-suorittavia lausekkeita, jotka selittävät koodin ja parantavat luettavuutta. Kääntäjä jättää ne huomiotta, eivätkä ne vaikuta ohjelman suorittamiseen.

Paranna koodin luettavuutta ja ylläpidettävyyttä.
Hyödyllinen virheenkorjauksessa ja logiikan dokumentoinnissa.

Java tukee kolmea pääasiallista kommenttityyppiä:

1. Yksiriviset kommentit

Yksirivisiä kommentteja käytetään kommentoimaan yhtä koodiriviä.

Syntaksi:

// Kommentoi tähän (Vain tämän rivin tekstiä pidetään kommentina)

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

Lähtö

Single Line Comment Above

2. Moniriviset kommentit

Monirivisiä kommentteja käytetään kuvaamaan monimutkaista koodia tai menetelmiä, koska useiden yksirivisten kommenttien kirjoittaminen voi olla työlästä.

/*
Kommentointi alkaa
jatkuu
jatkuu...
Kommentti loppuu
*/

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

Lähtö

Multi Line Comments Below

3. Asiakirjojen kommentit

Dokumentaation kommentteja käytetään ulkoisen dokumentaation luomiseen Javadocin avulla. Niitä käytetään yleensä ammattiprojekteissa luokkien menetelmien ja parametrien kuvaamiseen.

Syntaksi:

/**
* Kommentoinnin aloitus
* @param parametrin nimen kuvaus
* @palautuskuvaus
*/

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