JAVA コメント

GfG Practice で試してみる

Java では、コメントはコードを説明し、読みやすさを向上させる実行不可能なステートメントです。これらはコンパイラによって無視され、プログラムの実行には影響しません。

コードの可読性と保守性を向上させます。
ロジックのデバッグと文書化に役立ちます。

Java は、次の 3 つの主なタイプのコメントをサポートしています。

1. 単一行のコメント

単一行コメントは、コードの 1 行にコメントを付けるために使用されます。

構文：

// ここにコメント(この行のテキストのみがコメントとみなされます)

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

出力

Single Line Comment Above

2. 複数行のコメント

複数の単一行コメントを記述するのは面倒なため、複数行コメントは複雑なコードやメソッドを記述するために使用されます。

/*
コメント開始
続く
続いて…
コメント終了
*/

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

出力

Multi Line Comments Below

3. ドキュメントのコメント

ドキュメントコメントは、Javadoc を使用して外部ドキュメントを生成するために使用されます。これらは通常、専門的なプロジェクトでクラスのメソッドとパラメータを記述するために使用されます。

構文：

/**
※コメント開始
* @param パラメータ名の説明
* @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  );      }   }