主な内容の要点
初心者向けに、Javaで「コメント（プログラム中の説明）」を書く方法を整理します。コードを読みやすく・保守しやすくするために大切です。
コメントとは？
プログラム中に「この変数はこう使う」「この処理はこういう意味」など 人向けの説明を書いておく部分 のこと。
この「コメント」があっても、プログラムの実行には 一切影響しません。
つまり：動きには関わらず、読み手（＝自分・他の開発者）向けのメモです。
コメントの書き方（Javaでは３種類）
Javaでは、次の3つの書き方があります。
1. 単一行コメント
// ここからこの行末までがコメント
int sum = 0; // 変数sumを0で初期化
「//」が出現した位置からその行の終わりまでがコメント扱い。
行の先頭に書いてその行全体を説明にしてもOK、途中に書いてその後を説明にしてもOKです。
2. 複数行コメント
/*
複数行にわたって
コメントを書きたいときはこちら
*/
int sum = 0;
「/*」から「*/」までがコメント。改行も含めて複数行に渡って説明できます。
3. Javadoc形式コメント
/**
* クラス／メソッドの説明など
* - 作成者: 〇〇
* - 作成日: yyyy/mm/dd
*/
「/**」から「*/」までの形式。主に Javadocツール（自動ドキュメント生成）用のコメントとして使われます。
クラス宣言やメソッド宣言の直前にこの形式で書くと、自動でドキュメント化できます。
使い分けの目安
- 単一行コメント：処理の中のちょっとした補足説明に。
- 複数行コメント：処理の意図や手順をまとめて書きたい時に。
- Javadoc形式コメント：クラスやメソッドの仕様、引数・戻り値・用途を記述しておきたい時に。
サンプルコード（実際にどう書くか）
/**
* JSample
*
* 2014.01.01
*/
class JSample {
public static void main(String[] args){
int sum = 0;
// 10回繰り返す
for (int i = 1; i <= 10; i++){
sum = sum + i; // 数値を順に加算する
}
/* 集計した結果を画面に出力する */
System.out.println(sum);
}
}
このコードでは
- クラス宣言前にJavadoc形式コメント
- ループ前に単一行コメント
- 加算処理の直後に単一行コメント
- 出力前に複数行コメント を使っています。
どれも “プログラムの流れを人にわかりやすくするため” に書かれています。
初心者にとってのポイント
- コメントを書く 習慣を早めにつけること。後から自分や他人が見たときに「なぜこの処理をしてるの？」と迷わないように。
- ただし 書きすぎても読みにくくなるので、要点を簡潔に。
- プログラムが言語的に「何をしているか」だけでなく「なぜそれをしているか」を説明できるとベスト。
- Javadoc形式は、後からドキュメントを作るときに役立つので、クラスやメソッドを作ったら意識して書いておくとよいです。