Java ブロックコメント

Aryan Tyagi 2023年10月12日

Java Java Comment

Java では、コメントを使用して、コードに関する追加の説明と情報を提供することで Java コードの可読性を向上させ、コードの保守とバグやエラーの発見を容易にします。Java コードのコンパイル中に、コンパイラーはコメント内のテキストとステートメントを完全に除外します。

このチュートリアルでは、Java でのブロックコメントについて説明します。

ブロックコメントは、コードの多くの行に同時にコメントするために使用されます。/*と*/を使用してブロックコメントを挿入します。ブロックコメントは、多くの行に拡張することも、コードステートメント内に挿入することもできます。コメント区切り文字の間にあるテキストのみがコメントと見なされ、コンパイル時には無視されます。

例えば、

public class multilinecomment {
  public static void main(String[] args) {
    /* we have declared an integer n having value 007
    and a floating point variable z
    storing value of pi. */
    int n = 007;
    double z = 3.14;
    System.out.println(n);
    System.out.println(z);
  }
}

出力：

7
3.14

Java で利用可能な別のタイプの複数行コメントがあります。このために、/**と*/を使用してドキュメントのコメントを囲みます。これは、javadoc ツールによって作成されたプログラムの正式なドキュメント API を定義するために使用されます。javadoc は、ソースファイルのコレクション内の宣言とドキュメントコメントを解析し、クラス、インターフェイス、コンストラクタ、メソッド、およびフィールドを説明する HTML ページのコレクションを生成するツールです。

例えば、

public class javadoccomment {
  /**  multi() method returns multiplication of numbers.*/
  public static int multi(int a, int b) {
    return a * b;
  }

  /**  addition() method returns addition of numbers.*/
  public static int addition(int a, int b) {
    return a + b;
  }

  /**  subtract() method returns subtraction of numbers.*/
  public static int subtract(int a, int b) {
    return a - b;
  }
  public static void main(String[] args) {}
}

上記のコードを javac ツールでコンパイルすると、javadoccomment.java が取得され、クラス javadoccomment の HTML ファイルが作成されます。指定された HTML ファイルを開き、javadoccomment クラスのドキュメントコメントを確認します。