Develop and Download Open Source Software

category（Tag） tree

• root

================================================================================
名前: MergeDoc
種類: Java アプリケーション
動作環境: JRE 1.4 以上
ライセンス: CPL v1.0
URL： http://sourceforge.jp/projects/mergedoc/
================================================================================

Eclipse は日本語化しても Java 標準 API のメソッドなどにマウスを合わせたときにホバー表
示される説明は日本語化されません。これは Eclipse が JDK 付属の Java ソースから
Javadoc コメントを取得し表示しているためです。MergeDoc は日本語のホバー表示を可能にす
るために Java ソースと日本語 Javadoc API ドキュメントをマージするツールです。

またホバー表示以外にも次のような場合に参照するソースもコメントが日本語になります。

  - Java 標準 API のメソッドを Ctrl + 左クリック
  - Java 標準 API の例外スタックトレースからジャンプ
  - パッケージエクスプローラから rt.jar を辿ってクラスファイルを開く


動作確認済みの実行環境と Java ソースのバージョン

  一応動作が確認できている環境は下記のとおりです。私が確認したものと、使っていただいて
  いる方の情報をもとにしています。

    OS                JRE       Javaソース  Javadoc API ドキュメント
    -------------------------------------------------------------------
    Win2K(SP3)        1.4.2_01  1.2.2_008   jdk1_2update-doc-ja
    Win2K(SP3)        1.4.2_01  1.3.1_03    j2sdk-1_3_0-update1-doc-ja
    Win2K(SP3)        1.4.2_01  1.4.2_01    j2sdk-1.4.0-doc-ja
    Win2K(SP4)        1.4.2_02  1.4.2_02    j2sdk-1.4.0-doc-ja
    WinXP(SP1)        1.4.2_01  1.4.2_01    j2sdk-1.4.0-doc-ja
    Linux FedoraCore1 1.4.2     1.4.2       j2sdk-1.4.0-doc-ja

  Servlet API や Struts の API は Ja-Jakarta（http://www.jajakarta.org/）の有志の
  方々により日本語訳されたソースが配布されています。またこれらの Eclipse での利用方法
  については同 Ja-Jakarta のメンバでもある「あめのこやね（http://www.koyane.org/）」
  さんのサイトで詳しく解説されていますので、そちらをご参照ください。
  
  その他のものでも日本語 API ドキュメントが配布されている場合は MergeDoc でマージ出来
  るかもしれません。出来たとか、問題ありなどフォーラムなどでお知らせいただければ幸いで
  す。


================================================================================
インストール

  mergedoc.zip を適当な場所に解凍してください。
  以前のバージョンがある場合は置換定義ファイルを上書きしてしまうのでカスタマイズしてい
  る場合は事前に別の場所に退避してください。


アンインストール

  ディレクトリごと削除してください。


起動方法

  Windows で JAR ファイルに JRE/JDK 1.4 以上の javaw などが関連付いている場合は
  mergedoc.jar をダブルクリックすることで起動できます。それ以外の場合は以下のようなコ
  マンドで起動してください。

    java -jar mergedoc.jar

  mergedoc.bat は Windows 用のサンプル起動ファイルです。必要に応じてエディタなどで
  JAVA_HOME を編集してください。


  起動オプション

    -Dtarget.directory=ディレクトリ名

      ターゲットディレクトリに入力ソースアーカイブファイルがある有効なディレクトリを指
      定することで設定画面にデフォルトのファイル名が初期値としてセットされます。

        例）java -jar -Dtarget.directory=C:\j2sdk1.3 mergedoc.jar

      Javadoc API ドキュメントは JDK インストールディレクトリ内に配置しておくことを
      お勧めします。このオプションにより Javadoc API 参照ディレクトリも検出されます。
      また、このオプションを指定しなかった場合でも、Javadoc API 参照ディレクトリ設定
      時に入出力アーカイブファイルが自動で検出されます。

        例）C:\j2sdk1.3\docs\ja\api\


操作方法

  起動後の設定画面で設定を行い実行ボタンを押下してください。

    基本設定

     - Javadoc API 参照ディレクトリ

         日本語 Javadoc 標準 API ドキュメントを格納しているディレクトリを指定。
         package-list ファイルがあるディレクトリです。
         例）C:\j2sdk1.3\docs\ja\api
         
         省略した場合は日本語化は行われませんが詳細設定は適用されます。

     - 入力ソースアーカイブファイル

         Java 標準 API ソースアーカイブファイルを指定。
         例）C:\j2sdk1.3\src.jar

     - 出力ソースアーカイブファイル

         ソースを出力する新しいアーカイブファイルを指定。
         例）C:\j2sdk1.3\srcja.zip

     - 出力エンコーディング

         出力時の文字エンコーディングを指定。
         デフォルトを指定した場合はプラットフォームのデフォルトエンコーディングが使用
         されます。Eclipse で使用する場合は Eclipse のテキスト・ファイル・エンコード
         に合わせてください。

    詳細設定

        出力ソースの調整を行います。設定をカスタマイズする場合は conf ディレクトリの
        global.xml を参照してください。


Eclipse の設定

  Eclipse のパッケージエクスプローラから JRE システム・ライブラリー内の rt.jar を右
  クリックしてプロパティを開き Java ソースの添付でロケーションパスに MergeDoc で作成
  したソースアーカイブファイルを指定してください。

  ホバー表示したときに枠内にコメントが収まらない場合は F2 で固定表示し枠を広げることが
  可能です。


謝辞

  Eclipse wiki（http://www.eclipsewiki.net/eclipse/）の方々にたくさんの助言をいた
  だきました。感謝いたします。