Javaコードへのコメント追加方法を解説！3種類のコメントの使い分けとサンプルコード

Javaのコメントとは、コンパイラやインタプリタによって実行されない文のことです。変数、メソッド、クラス、あるいは任意のステートメントに関する情報を記述するために使用でき、コードの可読性や保守性を向上させるために欠かせない要素です。また、特定のコードを一時的に無効化（コメントアウト）する目的でも活用されます。

Javaコメントの3つの種類

Javaには、以下の3種類のコメントが用意されています。

• 単一行コメント（Single-line comment）
• 複数行コメント（Multi-line comment）
• ドキュメンテーションコメント（Documentation comment）

単一行コメント（//）

単一行コメントは「//」で始まり、その行の末尾までがコメントとして扱われます。短い説明や補足情報を手軽に記述したい場合に最適です。

サンプルコード 1

public class SingleLineComment {
    public static void main(String[] args) {
        // コンソールへ出力するためのコメント
        System.out.println("Welcome to Tutorials Point");
    }
}

実行結果

Welcome to Tutorials Point

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

複数行コメントは「/*」で始まり「*/」で終わります。複数行にまたがる長めの説明を記述できるため、処理の概要や注意点などをまとめて書きたい場合に便利です。

サンプルコード 2

public class MultiLineComment {
    public static void main(String[] args) {
        /* コンソールに "Welcome to Tutorials Point" を出力します。
           このように複数行にわたって
           コメントを記述することができます。
         */
        System.out.println("Welcome to Tutorials Point");
    }
}

実行結果

Welcome to Tutorials Point

ドキュメンテーションコメント（/** ～ */）

ドキュメンテーションコメントは「/**」で始まり「*/」で終わります。javadocツールを使用することで、このコメントからHTML形式のAPIドキュメントを自動生成できます。クラス、インターフェース、メソッド、フィールドの定義の直前に記述する必要がある点に注意しましょう。

サンプルコード 3

/**
 * ドキュメンテーションコメントのサンプルです。
 * Javaにおけるドキュメンテーションコメントの使い方を示すために作成されたクラスです。
 * このプログラムはコンソールに "Welcome to Tutorials Point" というテキストを表示します。
 */
public class DocumentationComment {
    public static void main(String args[]) {
        System.out.println("Welcome to Tutorials Point");
    }
}

実行結果

Welcome to Tutorials Point

まとめ

Javaのコメントには、単一行コメント「//」、複数行コメント「/* ～ */」、ドキュメンテーションコメント「/** ～ */」の3種類があります。それぞれの特徴を理解し、用途に応じて使い分けることで、チーム開発でも読みやすく保守しやすいコードを書くことができます。