Javadocとは
Javaのソースコードに記述されたJavadoc用のコメントから
HTML形式のAPI仕様書を作成してくれる便利機能！
記述形式
/**で始まり*/で終わる。
Javadocコメントの中には「説明文」と「Javadocタグ」を記述できる。
| タグ | 記述内容 |
|---|---|
@author |
開発者名 |
@param |
メソッドの引数や総称型のパラメータを記述する。 引数の数だけ記述する必要がある。 引数名と引数の概要を記述する。 |
@return |
メソッドの戻り値を記述する。戻り値がvoidの時は記述しなくて良い。 |
@exception |
メソッドが投げる例外クラスとその説明を記述する。 |
@version |
クラスまたはメソッドのバージョンを記述する。 バージョン管理システムを用いてこのバージョン番号割り当てを自動化することができる。 |
@deprecated |
廃止されたクラス やメソッドに付けられる。 コンパイル時にこれがつけられたメソッドを使用すると警告を発する。 |
ドキュメントを生成する
javadoc [options] [packagenames] [sourcefiles] [@files]