Java SE Javadoc Hobber の日本語文字化けを正す手順

コーディング中にJavaSE標準のAPIマウスカーソルをかざすと、Javadocがホバーしますよね。

 

私の環境(Windows 7/Eclipse Mars)では以下の問題が発生していました。

  • Java SEのJavadoc参照先が見つからない
  • 参照できるようになっても文字化けして閲覧できない

 

ネットで情報を調べても分かりにくかったので私の解決方法をシェアします。

 

  1. メニューから、「ウィンドウ>設定」をクリックします。

    f:id:jugemix:20160717140108p:plain

  2. 設定画面で、「Java>インストール済みのJRE」をクリックします。続けて、プロジェクトでビルドに使用しているJRE/JDKを選択し、「編集」ボタンをクリックします。f:id:jugemix:20160717140521p:plain

  3. JREの編集画面で、「JREシステム・ライブラリー」をCtrl+Aキーで全選択し、「Javadocロケーション」ボタンをクリックします。

    f:id:jugemix:20160717141529p:plain

  4. 開いたJavadoc画面で、「Javadocロケーション・パス」に「https://docs.oracle.com/javase/jp/8/docs/api/」を入力し、「検証」ボタンをクリックします。このパスには、「手順2」で選択したJREのバージョンと同じバージョンのjavadocを指定してください。f:id:jugemix:20160717141902p:plainインターネットで、「Java SE 8 japanese docs」と検索すると以下のサイトが検索できますので、これを指定します。

    f:id:jugemix:20160717204148p:plain

    ※1 英語のサイトもあるので、お好みでどうぞ。※2 「アーカイブ内のJavadoc」では、Oracle社のWebサイトからJavadocをダウンロードして、ローカルファイルから参照することもできます。

  5. 次のようなメッセージが表示されたら、コーディング中にJava SEのAPIにマウスをかざすことで現れるHobberに日本語のJavadocを表示することが出来ます。f:id:jugemix:20160717142050p:plain

  6. 結果は、下図のようになります。f:id:jugemix:20160717144548p:plain
  7. この時、「手順2」で指定したjreを使用しているプロジェクトの設定が「手順8」のような設定になっていないと、下図のように化けてしまうので注意が必要です。f:id:jugemix:20160717145154p:plain

  8. パッケージエクスプローラで、「手順2」で指定したjreを使用しているプロジェクトをクリックし、Altキー+Enterキーを押して、そのプロジェクトのプロパティー画面を表示します。f:id:jugemix:20160717150004p:plainファイルのエンコードの種類は、ご利用の環境に依存する場合があるので、ご注意ください。

初めて使うAPIの場合、Javadocの有/無によって生産性が変わってくると僕は思いますので、直しました。皆さんの生産性もこれで上がればいいなと思います。