目次
Javadocとは
Javaのソースコードから自動生成できるAPIドキュメントのことです。
また、そのドキュメントを生成する仕組み（ツール）そのものもJavadocと呼びます。
ソースコード内に特別なコメントを書いておくと、それをもとにHTML形式の仕様書が作られます。
Javadocを生成する手順
１．「ファイル」→「エクスポート」をクリックします。
２．「Java」 →「Javadoc」をクリックします。「次へ」をクリックします。
３．以下の操作をします。
①「Javadocコマンド」が空白の場合は「構成」ボタンを押してjavadoc.exeを指定します。
②「Javadocが生成される型の選択」でJavadocを生成するファイルを選択します。
③「次の可視性を持つメンバーのJavadocを作成」を選択します。Publicとした場合はPrivateのメソッドは出力されません。
④「宛先」で出力先を指定します。
⑤「次へ」を押します。
４．必要がある場合、修正します。「次へ」を押します。
５．必要がある場合、修正します。
※eclipseの文字コードの設定がUTF-8のために書き出しに失敗する場合は補足を参照願います。(ページ下部にあります）「完了」を押します。
結果確認
Javadocを生成すると手順の3で指定した場所にJavadocが生成されます。
生成場所として現プロジェクトのワークスペース配下を指定した場合は、EclipseにJavadocファイルが表示されます。
下図の赤枠の部分です。index.htmlを開くとJavaDocが表示されます。
Eclipseから確認する場合は、index.htmlを右クリックし、「次で開く」→「Webブラウザー」を選択します。
javadocです。
エラー: この文字は、エンコーディングMS932にマップできません
eclipseの文字コードの設定がUTF-8のため書き出しに失敗する場合
「エラー: この文字は、エンコーディングMS932にマップできません」
「Javadocの生成」ダイアログの「追加のJavadocオプション」に以下を記述します。
-encoding UTF-8
-charset UTF-8
関連の記事