コメントはソースコード中に注釈を入れる機能です。
コメントの概要
ソースコード中にコメントとして書かれた箇所については、プログラムの実行に一切影響を及ぼさないため自由に文章等を書くことができます。
一般的なコメントにはソースコードを理解しやすくするための説明を記載します。
また、機能変更やバグ対応などでソースコードを修正した時、修正前のソースコードを残すためにコメントが使われることもあります。
コメントの構文
Javaのコメントには単一行コメント、複数行コメント、JavaDoc用コメントの3種類あります。
単一行コメント
- (単一行コメント構文)
- //コメント
「//」以降、行末までがコメントになります。
複数行コメント
- (複数行コメント構文)
- /* コメント コメント */
「/*」と「*/」で囲んだ範囲がコメントになります。
1行でも複数行でもどちらでも構いません。
JavaDocコメント
- (JavaDocコメント構文)
- /** (JavaDocコメント) CommentSampleClass ここにこのクラスの概要をコメントします。 */
「/**」と「*/」で囲んだ範囲がJavaDocコメントになります。
コメントサンプル
public class CommentSampleClass {
/** (JavaDocコメント)ここにこのメソッドの概要をコメントします。 */
public String getMessage(int i){
//(単一行コメント)メッセージを定義する
String[] message = {"Hello", "GoodNight", "OhMyGod"};
/*
(複数行コメント)
メッセージを返す
*/
return message[i];
}
}
コメント