【Java】コメントアウトについて（まとめて行う方法や、一括削除について）

【Java】コメントの記述

コメントの役割

ソースコード内に注釈や説明を書き加えることで、コードの可読性や保守性を高めます。 同時に、一時的にコードの一部を無効化（コメントアウト）して動作確認やデバッグを行う際にも使われます。

コメントアウトの種類

単一行コメント（//）

・行末までをコメントとして扱い、コード中のちょっとした説明やTODOメモに最適です。 ・行頭に置くと、その行全体をコメントアウトできます。

複数行コメント（/* … */）

・複数行にまたがる注釈や一時的に大きなブロックを無効化したいときに使います。 ・ネストは禁止されているため、既存の /* */ の中にもう一つ書くことはできません。

Javadocコメント（/** … */）

・クラスやメソッド、フィールドのAPIドキュメントを自動生成するための特別なコメント形式です。 ・@param、@return、@throws といったタグを用いて詳細な情報を記述します。

サンプルプログラム

/**
 * Javatest.java
 * コメントの基本をまとめたサンプルクラス
 */
public class Javatest {

    public static void main(String[] args) {
        // 単一行コメント：プログラムのエントリポイント
        System.out.println("Hello, Java!");

        /*
         * 複数行コメント：
         * この部分は実行されません。
         * 必要に応じてブロックごと無効化できます。
         */
        // System.out.println("この行はコメントアウトされています");

        int result = add(3, 5); // メソッド呼び出し後に結果を受け取る
        System.out.println("3 + 5 = " + result);
    }

    /**
     * 2つの整数を加算して返すメソッド
     *
     * @param a 1つ目の整数
     * @param b 2つ目の整数
     * @return a と b の合計値
     */
    public static int add(int a, int b) {
        return a + b; // 計算ロジック
    }
}

実行結果

Hello, Java!
3 + 5 = 8

サンプル解説

• ファイル冒頭の /** … */ はクラス全体を説明する Javadoc コメントです。

• main メソッド内では // と /* … */ を使い分けて、行単位・ブロック単位でコードを無効化しています。

• add メソッドの前にも Javadoc コメントを置き、引数や戻り値の意味を明確に記述しています。

Eclipseでのコメントアウト削除の主な手法

 Ctrl + /

・コメントにする/戻す

任意の箇所を選択し、Ctrl + /を使用すると一括でコメントアウトができます。

Eclipse コメントアウトをまとめて解除できない場合

複数行まとめて解除しようとした際に、コメントされていない行が含まれる場合、解除できません。逆に、コメントアウトされます。