[Javadoc][生成]Javadoc生成

eclipse上からJavadocを生成する手順。
Javadocは/** ～ */までのコメント内に特定のシグネチャ（@で始まるキーワード）を埋め込むことによって、従来でいう関数仕様書のようなものを自動で生成するツール。

出来上がったJavadocはHTMLとなっており、見やすい上に詳細な記述ができるレイアウトである。おそらくこれを自分で1から作ったら何日もかかる。こうした自動生成により、ドキュメント作成にかける時間を短縮し、プロジェクトの効率化を図ることができる。
生成手順は下記の通り。

ソースファイル上のメソッド名をクリックし、行が選択された状態になったら右クリック。
メニューから[ソース]-[要素コメントの生成]でJavadoc形式のコメントを作成できる。

生成した要素コメントがJavadocにどう反映されるかは、次の操作でビューを表示することによって確認できる。
パッケージエクスプローラ上でソースファイルを選択する。
[ウインドウ]メニューから[ビューの表示]-[Javadoc]を選択すると、当該ソースファイルのJavaDocが見れる。

また、最終的にプロジェクトが完成した場合、次の手順によりプロジェクト全体のJavadocを生成することができる。
パッケージエクスプローラ上でプロジェクトを選択する。
[プロジェクト]メニューから[Javadocの生成]を選択すると、Javadocのドキュメントが生成される。

[Javadocの生成]は、プロジェクトが完成した時点で行うのが妥当。
途中でメソッドを追加すると、生成されたドキュメントがエラーとなり、パッケージエクスプローラ上で×印が付く。

生成されたドキュメントはプロジェクト配下のdocディレクトリに格納される。
これを全て削除してもう一度手順を実行すると、最新のソースファイルからJavadocが再度生成される。
docディレクトリのindex.htmlを見ると、プロジェクト全体のJavadocを概観できる。