コメント

コメントの必要性

コメントはプログラムの実行に全く影響を与えない説明文です。

プログラムにコメントは必ず必要です。作っているときにはわかっているつもりでも、時間がたつとどの部分がどんな働きだったか、なぜこのようにプログラムしたか忘れてしまうものです。

コメントがあるとそれを防ぐことができます。

また、大規模のプログラムでは分担して書くためにコメントをたくさん入れて他の人にも容易にやり方がわかるようにします。

javaの3つのコメント

javaには3つの形式のコメントがあります。

/* から */ まで。
これは C のルールと同じ
// から行末まで。
これは C++ で追加されたルールと同じ
/** から */ まで。
これは Java言語独自のルール。 このコメント内のテキストは、ソース・プログラムから機能仕様書を自動生成する時に利用されます。クラス定義やクラスのメンバーの宣言、定義の前には、このコメントを置くことが半ば義務づけられています。それ以外の場所でこの形式のコメントを用いると、コンパイル時にエラーとされます。

こんな風に使います。

/** 30 ÷ 4 × 5 を計算して表示します。 */
public class Keisan3 { 
       public static void main( String[] args ) {
               System.out.print( "30 ÷ 4 × 5 = " );
               System.out.println( 30.0 / 4 * 5 );     //30では整数で計算
       } 
}

いろいろな使い方

/* */ はこんな風にも使えます。

/** ***********************
 *  Keisan3                
 *  30 ÷ 4 × 5           
 *  を計算して表示します。 
 ************************* */
public class Keisan3 { 
       public static void main( String[] args ) {
             /*  いろいろやってみました
               System.out.println( 30 / 4 * 5 );
               System.out.println( 30.0 / 4 * 5 );
               System.out.println( 30 / 4.0 * 5 );
               System.out.println( 30 / 4 * 5.0 );
              */
               System.out.print( "30 ÷ 4 × 5 = " );
               System.out.println( 30.0 / 4 * 5 );
       } 
}

一番上は、プログラムの表題として枠で囲み目立たせる手法です。このへんは趣味の問題です。

/************* と始める場合は、/** のコメントと判断するようです。

2番目は何行かを /* の行と */ の行で挟んで一時的に無効にする例です。

/*     */ の中の一部(または全部)をさらに /*     */ で挟むことはできません。


Javaプログラミング(Feb.2009)
聖愛中学高等学校
http://www.seiai.ed.jp/
Aug.2003 初稿?