Javaのコメント

Javaだけでなく、プログラミング言語には「コメント」というものがあります。コメントはプログラム実行に一切反映されないので、プログラム中に日本語のメモができます。

特にルールというわけではありませんが、「コメント」を残すのはいわば常識といったところです。

１．コメントの必要性

他人が書いたプログラムや、自分で書いたプログラムを後から見ると「どんな処理をさせているのか」ひと目でわからないことが多々あります。

そういう場合、プログラムを目で追っていけばいいのですが、概要を知りたいだけの場合には無駄な時間がかかります。

そのため、プログラムを書く場合は、処理内容や修正履歴等をコメントしておくようにしましょう。そうすることでプログラムの保守性が上がります。

２．一行コメント

「//」を使うとそこから先の部分（1行）がコメント扱いとなり、プログラムに反映されません。

public class Sample{
public static void main(String args[]){
System.out.println("おはようございます");
//下の文は修正予定
System.out.println("こんにちは");
}
}

また、Javaの処理をコメント化することで、プログラムに反映させないこともできます。

public class Sample{
public static void main(String args[]){
System.out.println("おはようございます");
//System.out.println("こんばんは");
}
}

上では、「おはようございます」は出力されますが、「こんばんは」の部分はコメント化されているので出力されません。

３．複数行コメント

「/* ～～～～～ */」を使うと「/*」と「*/」の間に囲まれた部分がコメント扱いとなり、プログラムに反映されません。

public class Sample{
    public static void main(String args[]){
        System.out.println("Hello");
	/*
	この部分の処理は一時停止
	System.out.println("おはようございます");
	System.out.println("こんにちは");
	System.out.println("こんばんは");
	*/
    }
}

上は、「Hello」しか出力されません。

このように複数行コメントも、一行コメントと同様に、Javaの処理をコメント化できるので、書いたコードを削除することなく、一時的に処理を取り除いてあげることができます。

４．ドキュメントコメント

「/**」から始まり、各行ごとに「*」を記述し、最後は「*/」で締めるコメントです。

public class Sample{
    /**
    * main()メソッド
    * 最初に呼ばれるメソッドです。
    */
    public static void main(String args[]){
        System.out.println("Hello");
    }
}

コメント中に書かれた文章は、「javadoc」によってHTMLファイル化することができ、仕様書の文章とすることができます。また、「@」から始まるタグを使用することで、さらに詳細な情報を記述できます。

現段階ではドキュメントコードは使用しなくてOKです。