Java Doc 覚書 †
普通にjavaのソースにjavadocコメントを書いただけでは、概要ページがのっぺらぼうのjavadocが生成されます。
なので、概要ページに記述されるべき物の設定やらの覚書
各クラス・メソッドにはjavaDocコメントが記述されているのが前提
概要の説明ファイル作る †
- APIの概要ページの先頭に記述されるメッセージを作成します。
overview.htmlファイルを作成する †
各パッケージの説明ファイルを作る †
- APIの概要ページにて表示される各パッケージの説明を作成します。
package.htmlファイルを作成する †
情報 †
- クラスに禁則文字を使っているとjavaDocの生成対象から外れるそうです。 -- javadoc1.4? 2003-10-29 (水) 22:16:00
- [overview.html]のファイル名はjavadoc生成時にpathを通すのでぶっちゃけどんなファイル名でも良いと思うのですが、標準的に[overview.html]にするようです。 -- 概要? 2003-10-29 (水) 22:22:40
備考 †
参考