2012年2月11日土曜日

Eclipse INDIGO で javadoc 生成

Eclipse で javadoc を生成する方法をメモしておきます。

コメントの書き方やパッケージ情報の書き方については、
他のサイトを参考にしてください。
詳しく書いてあるサイトがたくさん有ります。
その辺りの前提が整えられているものとして進めます。


1,まずEclipseのメニューバーの[File]から[Export]をクリック。

2,[Java]から[Javadoc]を選択して、[Next>]ボタンをクリック。

3."Javadoc command" にjavadocのコマンドを絶対パスで記入($ which javadoc で探せます)。
Javadocを生成したいプロジェクトを選択し、保存先を指定します。(基本的にはデフォルトで構わないと思います。)

4.特に必要がなければデフォルトのまま[Next>]ボタンをクリック。
5.Overviewファイルを指定します(なくても生成自体は行えますが、生成されるドキュメントのトップページのコメントが無く、javadocとして不完全?です)。

ここで、重要なのが文字コードの指定です。
私は、TeXの関係で文字コードを全てEUC-JPで統一しています。このプロジェクトも例外ではなく、EUC-JPで書いています。
なので、Javadocの拡張オプションに
-encoding EUC-JP -charset EUC-JP
と指定します(各自の使用文字コードに合わせてください)。
最後に、[Finish]ボタンをクリックします。

指定した保存先にドキュメントが生成されます。
以上で完了です。

参考サイト
http://detail.chiebukuro.yahoo.co.jp/qa/question_detail/q1435959639

0 件のコメント:

コメントを投稿