Java/MergeDoc

MergeDocを利用して日本語コメントのJavaソースファイルを作成する。

MergeDoc - 日本語ドキュメントソースの作成

Eclipse や NetBeans などのIDEでメニューなどの表示は日本語で表示されていても、Java API のメソッドなどの説明は日本語では表示されない。これは、JDKに付属するJavaソースからJavaDocコメントを取得し表示しているためである。

なので、MergeDocを利用し、JDKに付属するJavaソースと日本語APIドキュメントをマージして、JavaDocコメントを日本語にしたJavaソースを作成する。また、これによってJDKのソースを参照したりする場合に表示されるソース(内の説明)も日本語で表示されるようになる。

Eclipse 3.2 以降では、JavaDocが指定されていると、そのJavaDocから説明を取得するため、各ライブラリのJavaDocが正しく(日本語のドキュメントに)指定されていれば、ホバー表示に関しては日本語化は不要となる。

Oracle は、1.3, 1.4, 5.0, 6.0 それぞれの日本語ドキュメントを Oracle Technology Network の“Java SE　旧バージョン日本語ドキュメントアーカイブ”で公開してる（ただし、tar での配布）。また、Java 7 に関しては日本語ドキュメントを用意していない。

• MergeDoc Project
  • http://mergedoc.sourceforge.jp/
• MergeDoc
  • http://mergedoc.sourceforge.jp/mergedoc.html
• Java SE　旧バージョン日本語ドキュメントアーカイブ - Oracle Technology Network
  • http://www.oracle.com/technetwork/jp/java/java-sun-1440465-ja.html

MergeDocは2種類のバージョンがあり、ドキュメントを作成した javadoc コマンドのバージョンによって使用する MergeDoc が変わる。JDK1.4以前は、MergeDoc 1.x.x を、JDK5.0 以降は、MergeDoc 2.x.x を利用する。

 日本語ソースの作成手順メモ

※JDK1.4以前は、サポートが切れているので無視。まぁ、基本的には同じだけど…。

MergeDocを適当なディレクトリに展開済み、JDKはソースも含めインストール済み( C:\Java\jdk1.6.0_13\ )、ドキュメントのアーカイブも取得して展開済み( C:\Java\jdk1.6.0-doc-ja\ C:\Java\jdk-6u10-docs-ja\ )とする。

JARファイルが関連づけされていれば、mergedoc.jar をダブルクリック。されていなければ、以下のようにコマンドで起動する。

> java -jar mergedoc.jar

ドキュメントのマージに比べて、コード変換のみのを行った方が早いです。ので、複数のエンコードを用意する場合、マージ済みを元に別のエンコードの物を作った方が、短時間ですむ。

日本語ソース マージ

起動したら、基本設定を以下のように設定する。詳細設定は好みに応じて。

APIドキュメントディレクトリ

C:\Java\jdk1.6.0-doc-ja\docs\ja\api C:\Java\jdk-6u10-docs-ja\ja\api

APIドキュメント エンコーディング

UTF-8 (Java 6の場合)、EUC-JP (Java 5.0, Java 6u10の場合)

入力ソースアーカイブ

C:\Java\jdk1.6.0_13\src.zip

入力ソース エンコーディング

※JDKの場合は ASCII 以外はないので適当に

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

C:\Java\jdk1.6.0_13\src_ja.MS932.zip

出力ソース エンコーディング

MS932 (必要に応じて MS932 や UTF-8 にする)

日本語ソース コード変換

コード変換のみを行う場合は、「APIドキュメントディレクトリ」を指定しない。

APIドキュメントディレクトリ

※何も指定しない

APIドキュメント エンコーディング

※なんでも

入力ソースアーカイブ

C:\Java\jdk1.6.0_13\src_ja.MS932.zip

入力ソース エンコーディング

MS932

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

C:\Java\jdk1.6.0_13\src_ja.UTF8.zip

出力ソース エンコーディング

UTF-8

 Servlet 2.4 API 日本語

JDKのAPIドキュメントと同様に、MergeDoc 2.x.x で jakarta-tomcat-5.x.x-src.zip^[1] と日本語ドキュメントをマージすることで、日本語で Servlet 2.4 API を参照することが出来る。

ソースファイルは Apache Tomcat から、Servlet 2.4 API 日本語ドキュメントは MergeDoc Project からそれぞれ入手出来る。