EclipseでjavaDoc

普通にjavaのソースにjavadocコメントを書いただけでは、概要ページがのっぺらぼうのjavadocが生成されます。
なので、概要ページに記述されるべき物の設定やらの覚書
各クラス・メソッドにはjavaDocコメントが記述されているのが前提

概要の説明ファイル作る

EclipseでjavaDoc生成

  • [プロジェクト]→[javadoc の生成]選択

javaDoc生成ウィザードの設定

  • 次のウィンドウでjavadocを生成したいプロジェクトを選択します
    javadoc01.jpg
  • 次へ進みます
  • 次のウィンドウで[文書タイトル]にチェックを入れタイトルを記入します。
    • このタイトルは概要ページの先頭にあるタイトルのことです。*1
      javadoc02.jpg
  • 次へ進みます
  • 次のウィンドウで[概説]にチェックを入れ[ブラウズ]から概要の説明ファイルoverview.htmlにパスを通します。
    javadoc03.jpg
  • 終了でjavadocを生成します。
    • javadoc1.4では[-quiet]なんてパラメータを付加してやると生成時のコンソールのコメントがErrorのみになります。*2

生成されたjavadocはこんな感じ

  • するとこんな感じで概要のページが生成されます。
    javadoc04.jpg
  • なんとなくそれらしくなったかと思います。



情報

  • クラスに禁則文字を使っているとjavaDocの生成対象から外れるそうです。 -- javadoc1.4? 2003-10-29 (水) 22:16:00
  • [overview.html]のファイル名はjavadoc生成時にpathを通すのでぶっちゃけどんなファイル名でも良いと思うのですが、標準的に[overview.html]にするようです。 -- 概要? 2003-10-29 (水) 22:22:40

備考

参考


*1 j2seだったら「JavaTM 2 Platform, Standard Edition, 1.4.0 API 仕様」とか書いてるやつです
*2 正常に生成されてるのにコメントはかれるのはうざいのでおすすめ

添付ファイル: filetest.war 290件 [詳細] filejavadoc04.jpg 534件 [詳細] filejavadoc03.jpg 552件 [詳細] filejavadoc01.jpg 541件 [詳細] filejavadoc02.jpg 484件 [詳細]

トップ   編集 凍結 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 単語検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2017-04-07 (金) 16:01:32 (230d)