Javadocの作成

JavadocはJavaソースコードからHTML形式のドキュメントを生成します。

Javaアプリケーションを作成するとき、保守などのために各プログラムの仕様書を作成しなければならない場合があります。ソースコードに含まれるクラスやメソッドなどを後から調べて仕様書を作成するのは簡単ではありません。

JavadocはJDKに標準で含まれているプログラムで、ソースコードに含まれるクラスやメソッドのコメントから自動的に仕様書を作成してくれる便利なツールです。ここではJavadocの書き方を中心に使い方を説明します。

Javadocの規則に従ったコメントの書き方を学ぶことで、Javaプログラミングにおけるコメント作成の標準も学べます。