Java Doc 覚書

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

概要の説明ファイル作る

  • APIの概要ページの先頭に記述されるメッセージを作成します。

overview.htmlファイルを作成する

  • overview.htmlファイルを作成します。*1
  • 中身に以下のように記述します。
    <html>
    <head>
    </head>
    <body>
    このドキュメントはアプリケーション「test」のAPI仕様です.<br>
    「test」はなんでもありのサーブレット実験用アプリケーションです.
    </body>
    </html>

    Bodyの1行目が概要になります。2行目からは説明

    • このファイルをソースのrootディレクトリに置きます
      • Eclipseで素直にプロジェクトを作っている場合「src」配下

各パッケージの説明ファイルを作る

  • APIの概要ページにて表示される各パッケージの説明を作成します。

package.htmlファイルを作成する

  • package.htmlファイルを作成します。*2
  • 中身に以下のように記述します。
    <html>
    <head>
    </head>
    <body>
    各種テストクラスを提供します
    </body>
    </html>

    Bodyに説明を記述します。

    • このファイルを各パッケージ配下に置きます。するとそのHTMLがそのパッケージの説明になります。
    • 各パッケージに同じようにpackage.html置いていきます。

情報

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

備考

参考


*1 ただのhtmlです
*2 やっぱりただのhtmlです

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