Javaのコメント記述

メモ:

Javaを使った開発案件が少しずつ発生しているため、作ってみたもののいろいろ不明な点が多く、悪戦苦闘中です。そんなわけで、基礎からまとめていこうと思っております。

Hello World!は終わったので、次はコメントです(笑)

Javaでのコメントの書き方

Javaプログラムでコメントを書くには、次の3つの方法があります。

1.複数行のコメント

/* コメント1
コメント2
コメント3 */

/*と*/の間がコメントとされ、複数行のコメントを作成できます。

2.単一行コメント

// コメント

//で始まる場合、行末までがコメントとなります。

3.ドキュメントに出来るコメント

/** コメント1
コメント2
コメント3 */

Javaでプログラムを行う場合、javadocといわれるドキュメントに出くわすことがあります。

上記のコメント形式で作成されたコメントは、javadocツールを使うことによりドキュメント化することができます。

参考

一例ですが、javadocツールでは、次のようなコマンドでドキュメントを生成してくれます。

javadoc -public -d doc -sourcepath src net.bnote.hoge net.bnote.hogehoge