人間がプログラムを読みやすくするために、 プログラム中に注釈を書くことができます。 これをコメント (comment) と言います。 プログラムの実行時にコメントの部分は無視されます。
コメントの書き方には 3 種類あります。
// Comment is here.
"//
"の後は、行の最後までがコメントになります。
プログラムの実行文の先頭に"//
"を付けて、
一時的にこの部分を実行しないようにすることもあります。
/* Comment is here. */
/* Here is a comment more than one line. */
"/*
"と"*/
"に挟まれた部分はコメントになります。
コメントが複数行に渡ることもできます。
プログラムのある範囲をコメントにし、
一時的に実行しないようにすることもあります。
ただし、コメントは入れ子にして使うことはできません。 例えば、以下のようなコメントはエラーとなります。
/* Comment is here. /* Nested comment is not allowed */ */
/** comment is here. */
"/**
" と"*/
"で挟まれた部分は
ドキュメンテーションコメント (Documentation Comment) と呼ばれます。
ここに書かれた内容は、
ドキュメント作成ツールによって取り出され、
プログラムのマニュアルなどを自動的に作成することができます。
JDK の中には、この処理を行う javadoc
という
プログラムが用意されています。
また、ドキュメンテーションコメントは、使える場所が限られています。