EclipseのJavadocの生成方法です。
Javadocとは、Javaのソースコードから作成されるHTML形式の仕様書です。
| 確認環境 eclipse 4.7/4.6/4.5 |
目次
手順
１．「ファイル」>「エクスポート」をクリックします。
２．「Java」 >「Javadoc」をクリックします。「次へ」をクリックします。
３．以下の操作をします。
①「Javadocコマンド」が空白の場合は「構成」ボタンを押してjavadoc.exeを指定します。
②「Javadocが生成される型の選択」でJavadocを生成するファイルを選択します。
③「宛先」で出力先を指定します。
④「次へ」を押します。
４．必要がある場合、修正します。「次へ」を押します。
５．必要がある場合、修正します。
※eclipseの文字コードの設定がUTF-8のために書き出しに失敗する場合は補足を参照願います。(ページ下部にあります）「完了」を押します。
結果確認
Javadocを生成すると手順の3で指定した場所にJavadocが生成されます。
生成場所として現プロジェクトのワークスペース配下を指定した場合は、EclipseにJavadocファイルが表示されます。
下図の赤枠の部分です。
index.htmlをクリックするとjavadocを表示します。
javadocです。
補足(エラー: この文字は、エンコーディングMS932にマップできません)
eclipseの文字コードの設定がUTF-8のため書き出しに失敗する場合
(エラー: この文字は、エンコーディングMS932にマップできません)
「Javadocの生成」ダイアログの「追加のJavadocオプション」に以下を記述します。
-encoding UTF-8
-charset UTF-8
関連の記事
Java Javadocタグの記述と見え方のサンプル
Eclipse デバッグの方法
Eclipse 他のプロジェクトを参照する/プロジェクトを閉じる・開く方法
Eclipse 外部jarファイルをクラスパス(ビルドパス)に設定する方法
Eclipse フォルダを作成してビルドパスに設定する手順