Java コメント文(Comment)

コメント(comment)は、ロジックの説明やコードを無効化するときに使用する。コメントはコードに影響せず、コンパイル、つまりプログラム解釈の対象から除外される。

Java で使用できるコメント文には 3 種類がある。

単一行コメント(Single-line comment)

// からその行の終わりまでがコメント処理される。

public static void main(String[] args) {
    // 整数変数を宣言するときは、次のようにコードを書く。
    int num1;
}

ブロックコメント(Multi-line Comment)

/* から */ までのすべての内容がコメント処理される。

public static void main(String[] args) {
    int num1 = 100;
    int num2 = 200;
   
    /* 下のコードは宣言した整数の合計を計算して表示する。
       num1 は 100、num3 は 200 なので結果は 300 になる。 */
    System.out.println(num1 + num2);
}

性質上、複数行コメントをネストすることはできないため注意が必要である。そのため、一般的にはまず // を優先して利用することを推奨する。

ドキュメントコメント(Document comment)

/** から */ までのすべての内容がコメント処理される。プログラムを文書化するために javadoc で生成される HTML ファイルで使用される。 コメント内容には HTML タグを使用できる。

/**
 * main メソッドは Java アプリケーションの実行開始点です。
 */
public static void main(String[] args) {
    String str = null;
}