eclipse で JavaDoc を自動生成する方法について説明します。
Javadoc というのは Javaプロジェクト についての HTMLファイル のことです。 要するに、クラスやそのメソッドなどをまとめたドキュメントです。
準備
Javadoc を生成するには、まず Javadoc のためのコメントをつける必要があります、 次のように。（これは、ショートカットキー Shift + Alt + J でもできます。）
|
1 2 3 4 5 6 7 |
/** * ～メソッドの説明～ * * @param a * @return void */ private void ... |
方法
Javadoc コメント がかけたところで、 Javadoc を生成します。
メニューバーのプロジェクト(project)から javadoc 生成 (Generate Javadoc) を選びます。 すると、ウインドウが開き、どの javadoc を作るのか、どの場所に作るのかを選択できるようになります。 あとは画面の指示に従ってやっていけば Javadoc が生成されます。
