EclipseでJavadocの出力

みなさ~ん、Eclipse使ってますか~?ワシもじゃ、ワシもじゃみんな!!

というわけで、今回はJavadocをメモメモ。

OracleのサイトでJavadocをダウンロード

Java SE API & ドキュメント にアクセスし、

f:id:ts0818:20170906210005j:plain

下の方にある、「Java SEのバージョン 1.3.0、 1.4.0 、5.0、6、7、8の日本語ドキュメントは、こちらのページでアーカイブ・ファイルも提供しています。」の「こちら」をクリック。

f:id:ts0818:20170906210001j:plain

Java Platform Standard Edition 8 (85.1MB)」をクリック。(お使いのJavaのバージョンに合わせます)

f:id:ts0818:20170906205952j:plain

zipファイルがダウンロードされ、

f:id:ts0818:20170906205948j:plain

ダブルクリックすると、フォルダがあるので、

f:id:ts0818:20170906205943j:plain

コピーして、 

f:id:ts0818:20170906211526j:plain

「C:¥Users¥ユーザ名¥Documents」 とかに張り付けます(配置場所は特に決まってないので自由な場所で構わなさそうです。)

f:id:ts0818:20170906211522j:plain

配置できたら、フォルダを選択し、「F2」キーを押し、

f:id:ts0818:20170906211516j:plain

名前を分かりやすいものに変更します。ここでは「docs」にしてます。

f:id:ts0818:20170906211512j:plain

「C:¥Users¥ユーザ名¥Documents¥docs」までのパスを後で使います。

f:id:ts0818:20170906211502j:plain

 

EclipseJavadocの出力を使えるよう設定

Eclipseを起動し、 「プロジェクト・エクスプローラー」の中のプロジェクトを選択した状態で、「ファイル(F)」>「エクスポート(O)...」を選択。

f:id:ts0818:20170906214934j:plain

Java」>「Javadoc」を選択。

f:id:ts0818:20170906214931j:plain

Javadocが生成される方の選択(T):」で複数プロジェクトも選択できます。「次の可視性を持つメンバーのJavadocを作成:」は「public(U)」にし、「宛先」で「参照(W)...」を選択。

「基本オプション」「これらのタグの記述」にチェックをし、「次へ(N)>」をクリック。

f:id:ts0818:20170906215744j:plain

「完了(F)」をクリック。

f:id:ts0818:20170906215741j:plain

「すべてはい(A)」をクリック。

f:id:ts0818:20170906215736j:plain

「ライブラリー」>「JRE システムライブラリー」>「プロパティー(R)」を選択。

f:id:ts0818:20170907072957j:plain

Javadoc ロケーション」を選択し、「参照」をクリック。

f:id:ts0818:20170907072953j:plain

ローカルに配置したJavadocドキュメント(「C:¥Users¥ユーザ名¥Documents¥docs」)のフォルダを指定し、「OK」。

f:id:ts0818:20170907072950j:plain

「適応」をクリック。 

f:id:ts0818:20170907072945j:plain

「OK」をクリック。

f:id:ts0818:20170907072942j:plain

 

 

 

EclipseJavadocの出力を使う

Javadocの出力を設定したプロジェクトの中で、適当なファイルを開いてメソッド名などにカーソルを合わせ、「Shift + F2」を押すと、

f:id:ts0818:20170906220300j:plain

JavaAPIのような説明を出力してくれます。

f:id:ts0818:20170906220257j:plain

Javadoc出力を指定したプロジェクト内のファイルなら、

f:id:ts0818:20170906221133j:plain

表示してくれます。

f:id:ts0818:20170906221129j:plain

 

ネットの使えない現場で、初めに入れさせてもらえれば むちゃくちゃ助かりますね。