1.Javadocとは
Javadocとは、JavaのソースコードからHTML形式のAPI仕様書を生成するものです。
Javadocは下図5.1のようなJavaクラスの仕様書の標準の書式です。
例えば、皆さんおなじみのJavaのAPIもJavadocで書かれています。
Javaの技術者の共通理解がありますので、この形式でドキュメントを残すと非常にわかりやすいです。
2.Javadoc用のコメント
Javadoc用のコメントは、以下のように書きます。
/** * Javadoc用のコメントです。 */
「@」を使い、以下のような特殊な意味を持たせることが可能です。
@author：作成者
@version：バージョン指定
@param：パラメータに関する説明
@return：戻り値に関する説明
@throws(@exception)：発生する可能性のある例外に関する説明
@deprecated：クラスやメソッドなどを「非推奨」として指定
3.Javadocを生成するJavaのソースコードの例
NetBeansを使いJavadocを生成するには、プロジェクト・エクスプローラーでプロジェクトを右クリックして、「javadocの生成」を選択するだけです。
生成されたjavadocは以下のとおりです。
生成されたJavadocを後から見るには、ソースコードの中でパッケージ名やクラス名、メソッド名を選択した状態で右クリックしてコンテキストメニューを表示、「Javadocを表示」を選ぶとブラウザに表示されます。
なお、JSPはJavaDocにはなりません。