Javadocロケーションの設定

感想おまちしてます!

EclipseでJavaコードを書いているときに、「あれ?このメソッドってどんな処理やってくれるんだっけ??」と思うことはありませんか?あるでしょう。そういうときに、ブラウザを開いて、Javadoc開いて。。。とやるのはとてもめんどくさいことです。
EclipseにはJavadocを関連付ける機能が初めからついています。これを利用して快適にEclipseを使いましょう。

* ただ、Eclipse3.xでブラウザを開くとだんだん重くなるみたい。

JREシステムライブラリの関連付け 

JREシステムライブラリとは、Javaがデフォルトで提供してくれるAPIの詰まったJarファイルです。これを関連付けることにより、JREのメソッドなどのJavadocを直に参照できるようになります。

rt.jar

パッケージエクスプローラを開き、rt.jarを探してください。そして、そのJarファイルの上で右クリック>プロパティと選択します。

rt.jarなどをワーキングセットで隠している場合は、表示させましよう。

Javadocロケーション 

JavadocロケーションにJavadocの場所を設定します。
1.3の場合は「http://java.sun.com/j2se/1.3/ja/docs/ja/api/
1.4の場合は「http://java.sun.com/j2se/1.4/ja/docs/ja/api/
を「Javadocロケーションパス」に設定してあげましょう。
(/apiまでのパスを設定しなければならないようです)

また、ローカルでJavadocを持っている場合、zipファイルのようなアーカイブを設定することも可能です。インターネット環境がない場合に
は、ドキュメントをダウンロードしておくといいでしょう。
この場合、Javadocロケーションの下側「アーカイブ内のJavadoc」にアーカイブを指定します。アーカイブの場合も「file:/C:
/java/javadoc/j2sdk-1_4_0-doc-ja/docs/ja/api/」のように、/apiまでのパスを指定します。

EclipseからJavadocを参照する 

それではEclipseからJavadocの参照を行います。右図ではString.indexOfメソッドにカーソルを置きました。その状態で「Shift + F2」を押してください。

するとJavadocのString.indexOfメソッドの詳細がブラウザに表示されます。ブラウザはもちろん自動的に立ち上がります。

オリジナルのJavadocを参照する

以上は、JREの参照でした。しかし、プロジェクトで作成したクラスなどがあるばあい、そちらのJavadocを参照したいときもあるでしょう。
そういう場合は、まずJavadocを作っておき、プロジェクトの上で右クリックします。
Javadocロケーションは

  • プロジェクトごとに設定可能
  • JREごとに設定可能
    というわけです。
    外部Jarなどを読み込んでいる場合は、それぞれのJarを右クリックして、参照先を指定してあげるといいでしょう。

Javaソースの関連付け 

Eclipseではメソッドなどの上で、「右クリック>宣言を開く」と選択することで、選択したメソッドのソースが表示されます。JREが提供する
APIのソースを見るために、Javadocの関連付けと同じように設定することがEclipseでは可能です。(かしこいですね?)

Javadocの時と同じように、rt.jarの上で「右クリック>プロパティ」と選択してください。そして、「Javaソースの添付」を開きます。

そして、ロケーションパスにsrcアーカイブまでのパスを設定します。
こうすることで、srcと関連付けられ、宣言した内容を確認することができます。