JavaDocを生成する

Javaにはソースコード内に記述したコメントをJavaDocとしてHTML形式で見る事ができます。
実際に作成したアプリケーションが、どういった内容で作られているかがわかる為、
後々メンテナンスする際に非常に役に立ちます。
(例えば、これしたいけど何か機能無いかな・・・など)

方法として
1.コマンドプロンプトを使い生成
2.Eclipseの機能を使い生成

まぁ通常であればEclipseを使っているので、その方法でやってみます。
①Eclipseツールバーの「プロジェクト」から「JavaDocの生成」を選択
②JavaDoc保存先がプロジェクト内だとチームで共有している際に面倒になるので保存先を変更します。
⇒標準ドックレットを使用の参照ボタンで別の場所を指定します(保存先に日本語や空白不可/C直下がベスト)
③後は指示の通り進めていき、最後の追加コマンドでプロジェクトが使用している文字コードを設定します。
⇒今回はUTF-8のプロジェクトの為、「-encoding UTF-8」を追加

以上で簡単にJavaDocの作成ができました。
JavaDoc作成

JavaDoc用のコメントの作成例は以下のサイトや生成時のログを見るとわかると思います。
JavaAPI生成

カテゴリー: パソコン パーマリンク