<<PREV | ToC | NEXT>>

コメントアウト

基本的なコメント

ソースコードには後々の保守点検用に注釈を記述しておきたいことがあります。ソフトウェアのライフタイムの殆どは保守／運用局面です。その後廃棄されるか、新しいものに移行するのかは分かりませんが、コーディングした worker と保守／運用局面の worker が同一人物であることは稀です。

自分のコーディングしたソースコードを分かりやすくする為に、注釈を記述することが出来ます。複雑になると、開発途中にでも記述したほうが、自分にも分かり良いでしょう。

コンピュータの制御 (control) とは関係ない注釈をコメントと呼びます。Java のコメントは JavaScript, C/C++ などの言語と同じ形式です。

/* ここはコメントです。
 * 複数行でもかまいません。*/
class Howdy {
	// この行はコメント
	public static void main(String[] args) {
		System.out.print("Howdy, Java!");  // ここから後ろだけコメント
	}
}

複数行に及ぶコメントの場合は、 "/*" から "*/" までがコメント部分です。

単一行内の場合は、 "//" から改行までがコメント部分です。当該行の "//" 以前の部分はコメントではなく、プログラム・ステートメントの一部分だと解釈されますので、注意してください。

ドキュメンテーション

他にも、 /** から */ までのコメントも利用できます。

標準クラスライブラリの java.lang.System の一部抜粋：

/**
 * The <code>System</code> class contains several useful class fields
 * and methods. It cannot be instantiated.
 * <p>
 * Among the facilities provided by the <code>System</code> class
 * are standard input, standard output, and error output streams;
 * access to externally defined "properties"; a means of
 * loading files and libraries; and a utility method for quickly
 * copying a portion of an array.
 *
 * @author  Arthur van Hoff
 * @version 1.111, 02/02/00
 * @since   JDK1.0
 */
public final class System {
	//省略
}

このコメント形式は、 javadoc というドキュメンテーションツールの為のものです。このソースを javadoc に読み込ませると、 API 文書形式の HTML 文書が自動的に出力されます。直後のクラス定義やメソッドなどに関連付けられると覚えておくと良いでしょう。

<<PREV | ToC | NEXT>>