FeaturesPluginsDocs & SupportCommunityPartners

生成する Javadoc のエンコーディングを指定する


Javadoc のエンコーディングはなぜ必要か

Javadoc を生成するコマンドは通常そのコマンドが実行されるロケールのエンコーディングになります。例えば Windows で Javadoc を生成するとその HTML ファイルは Shift JIS エンコーディングで作成されます。Solaris などの ja ロケールでは EUC になります。ただしエンコーディングがヘッダに含まれません。したがって違うプラットフォームや違うロケールで使おうとした場合には IDE からはどのエンコーディングで書かれたものか判断がつきません。

したがって Javadoc を公開する場合や、複数の人で共同で開発している場合などでは、エンコーディングの情報はできるだけ Javadoc に入れたほうがよいでしょう。

NetBeans IDE で Javadoc のエンコーディングを指定する方法

次の方法でエンコーディングを指定できます。プロジェクトのプロパティーダイアログの「ドキュメント化」カテゴリで指定できます。

1. プロジェクトの「プロパティー」ダイアログを開きます

2. 「カテゴリ」から「ドキュメント化」の項目を選びます

3. 「追加の Javadoc オプション」に javadoc の引数を指定します



UTF-8 を指定する場合には

-charset UTF-8 -docencoding UTF-8
  
-charset は HTML 文字セットを指定します、-docencoding は Javadoc 自体のエンコーディングを指定します。
Companion
Projects:
MySQL Database Server   Open JDK: an Open SourceJDK   GlassFish Community: an Open Source Application Server    Mobile & Embedded Community    Open Solaris   java.net - The Source for Java Technology Collaboration   Virtual Box - full virtualizer  Open ESB - The Open Enterprise Service Bus Powered by