View 2.0.3 - Release Notes
file info- category（Tag）
- root
- file name
- MergeDoc_2.0.3_-_Notes
- last update
- 2004-12-31 02:52
- type
- Plain Text
- editor
- 柏原 真二
- description
- 2.0.3 - Release Notes
- language
- English
- translate
================================================================================
MergeDoc
--------------------------------------------------------------------------------
実行環境: JRE5.0 以上
URL： http://sourceforge.jp/projects/mergedoc/
================================================================================
Eclipse は日本語化しても Java 標準 API のメソッドなどにマウスを合わせたときにホ
バー表示される説明は日本語化されません。これは Eclipse が JDK 付属の Java ソース
から Javadoc コメントを取得し表示しているためです。MergeDoc は日本語のホバー表示
を可能にするために Java ソースと日本語 API ドキュメントをマージするツールです。
またホバー表示以外にも次のような場合に参照するソースもコメントが日本語になります。
- Java 標準 API のメソッドを Ctrl + 左クリック
- Java 標準 API の例外スタックトレースからジャンプ
- パッケージエクスプローラから rt.jar を辿ってクラスファイルを開く
↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓
対象ソース:
JDK5.0 対応のソースと JDK5.0 付属の javadoc コマンドで作成された API
ドキュメント。JDK1.4 以前のソースは MergeDoc 1.2.8 を使用してください。
↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑
--------------------------------------------------------------------------------
使用方法
--------------------------------------------------------------------------------
インストール
mergedoc.zip を適当な場所に解凍してください。
以前のバージョンがある場合は置換定義ファイルを上書きしてしまうのでカスタマイズ
している場合は事前に退避してください。
また 1.2.8 以前とはディレクトリ構成が異なるので上書きしないようにしてください。
アンインストール
ディレクトリごと削除してください。
起動方法
Windows で JAR ファイルに JRE/JDK5.0 以上の javaw を関連付けている場合は
mergedoc.jar ダブルクリックで起動します。また mergedoc.jar のショートカットで
も起動出来ます（ショートカット用のアイコンは \conf\icon.ico）。
[Windows での jar ファイル関連付け設定例]
"c:\jdk1.5.0\jre\bin\javaw.exe" -server -jar "%1" %*
それ以外の場合は次のようなコマンドで起動してください。
java -server -jar mergedoc.jar
-server オプションは必須ではありませんが、MergeDoc の場合、指定したほうが
ほとんどの環境で高速化されます。なお、このオプションを使用するには JDK ではなく
JRE の bin にパスが通っている必要があります。
起動オプション
-Dtarget.directory=ディレクトリ名
ターゲットディレクトリに入力ソースアーカイブファイルがある有効なディレクト
リを指定することで設定画面にデフォルトのファイル名が初期値としてセットされ
ます。
例）java -jar -Dtarget.directory=C:\jdk1.5.0 mergedoc.jar
API ドキュメントは JDK インストールディレクトリ内に配置しておくことをお勧
めします。このオプションにより API ドキュメントディレクトリも検出されます。
また、このオプションを指定しなかった場合でも、API ドキュメントディレクトリ
設定時に入出力アーカイブファイルが自動で検出されます。
例）C:\jdk1.5.0\docs\ja\api\
操作方法
起動後の設定画面で設定を行い実行ボタンを押下してください。
ファイルやディレクトリはドラッグ＆ドロップ可能です。
基本設定
* API ドキュメントディレクトリ
日本語 API ドキュメントを格納しているディレクトリを指定。
package-list ファイルがあるディレクトリです。
例）C:\jdk1.5.0\docs\ja\api
J2SE 5.0 日本語 API ドキュメントの場合、エンコーディングは EUC-JP に
してください。
* 入力ソースアーカイブファイル
Java ソースアーカイブファイルを指定。
ファイル形式は「.zip」「.jar」「.tar.gz」「.tgz」のいずれか。
例）C:\jdk1.5.0\src.zip
エンコーディングは JDK の場合、ASCII 以外の文字が含まれていないので
何でもかまいません。
* 出力ソースアーカイブファイル
ソースを出力する新しいアーカイブファイルを指定。
ファイル形式は「.zip」「.jar」のいずれか。
例）C:\jdk1.5.0\srcja.zip
エンコーディングは使用するエディタや IDE の設定に合わせてください。
Eclipse の場合はテキスト・ファイル・エンコードと同じにします。プロジェ
クトによってエンコードが異なる場合は srcja_MS932.zip、srcja_EUC-JP.zip
などのように複数のファイルを作成しておくと良いと思います。
詳細設定
出力ソースの調整を行います。設定をカスタマイズする場合は conf ディレクト
リの global.xml を参照してください。
API ドキュメントディレクトリを省略して実行することで Java ソースファイルの文字
コードの変換のみを行うことが可能です。その場合でも詳細設定は適用されます。なお
その他のファイルは文字コード変換も詳細設定も適用せずそのまま出力します。
例えばマージ済みの srcja_EUC-JP.zip を元に srcja_MS932.zip を作成することが出
来ます。マージに比べ、コード変換のみのほうがかなり高速です。
Eclipse で使用する場合の設定
Eclipse のパッケージエクスプローラから JRE システム・ライブラリー内の rt.jar
を右クリックしてプロパティを開き Java ソースの添付でロケーションパスに MergeDoc
で作成した出力ソースアーカイブファイルを指定してください。
ホバー表示したときに枠内にコメントが収まらない場合は F2 で固定表示し枠を広げる
ことが可能です。
補足:
J2SE5.0 日本語 API ドキュメント（2004年12月公開）は、既に元の Java ソースと
内容がかみ合わない部分があります。これらはマージ結果に以下のような影響が
あります。
1. クラス階層の不一致
例えば Java ソース上は StringBuilder や StringBuffer の親クラスは
AbstractStringBuilder ですが、API ドキュメントでは親クラスは Object に
なっており AbstractStringBuilder が存在しません。また、メソッドなどの
ページ内リンクが動作せず、HTML フォーマットもなぜか他のクラスとかなり
異なるようです。
Java ソース上のコメントは AbstractStringBuilder に記述され、サブクラスと
なる StringBuffer などの Javadoc コメントは省略（継承）されています。
このようなクラスはコメントのマッチングが不可能なためマージはほとんど
行われません。
2. <pre> タグ内の改行情報の欠落
例えば String や Thread などのクラスコメントに記述されている <pre> タグ内
コードの改行情報が欠落し 1 行になっています。これはブラウザで確認すること
ができます。
今のところ MergeDoc では元の Java ソース <pre> タグ内容を使用することで
この問題を回避しています。 | 
|