Javaコメント：種類、使い方、ベストプラクティス

Javaコメント

このガイドでは、Javaコメントの種類、重要性、正しい使い方を説明し、より明確で保守しやすいコードを書く手助けをします。

プログラミングにおいて、コメントはJavaコンパイラが無視するソースコードのセクションです。実行に影響を与えずに、開発者がコードの意図を理解するのを助けます。例えば：

// 2つの変数を宣言して初期化
int a = 1;
int b = 3;
// 出力を表示
System.out.println("This is output");

ここでは2つのコメントを使用しました：2つの変数を宣言して初期化と出力を表示。

Javaのコメントの種類

Javaは主に2つのコメントスタイルをサポートしています：

単一行コメント
複数行コメント

単一行コメント

単一行コメントは//で始まり、行の終わりまで続きます。例：

// "Hello, World!" プログラムの例
class Main {
    public static void main(String[] args) {
        // "Hello, World!"を出力
        System.out.println("Hello, World!");
    }
}

出力：

Hello, World!

2つの単一行コメントを使用しました："Hello, World!" プログラムの例と"Hello, World!"を出力。コンパイラは//から行末までを無視します。

複数行コメント

複数行必要な場合は/* … */を使用します。例：

/* これは複数行コメントの例です。
 * プログラムは"Hello, World!"を標準出力に出力します。
 */
class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}

出力：

Hello, World!

コンパイラは/*と*/の間のすべてをスキップします。これは伝統的なコメントとも呼ばれます。

コメントを効果的に使う

コメントは明確なコードの代わりにはなりません。まず、よく構造化された自己説明的なコードを書き、その後で「なぜ」その決定をしたのか（複雑なアルゴリズム、設計選択、自明でないロジック）を説明するコメントを追加します。

一部の人は最小限のコメントを推奨しますが、簡潔な説明は将来の保守者にとって可読性を大幅に向上させます。

注意: コードが「どう」動くかよりも、「なぜ」そのコードが存在するかを説明するコメントを優先してください。

Javaの式、文、ブロックを理解する Java if…elseをマスター：制御フローを徹底解説

Java