Javadocで使えるタグです。
主要Javadocタグ
| タグ | 意味 |
|---|---|
| @author | 作成者 |
| @version | バージョン |
| @param | 引数の説明 ※@paramは引数の数分作成します |
| @return | 戻り値の説明 |
| @throws | 発生する可能性のある例外 |
| @exception | ※@throwsと同じ |
| @since | 導入されたバージョン ※@versionは現在のバージョンを表します |
| @see | 関連項目 ※文字列でも他サイトへのURLでもOK ※リンクを張りたい場合はHTMLのaタグで記述します |
| @deprecated | 非推奨を明示する |
Javadocサンプル
書式は以下のようになります。
|
1 2 3 4 |
/** * ＜説明文＞ * ＜タグ＞ */ |
例）Javadocサンプル
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
サンプル /** * 横幅と高さから<br> * 面積を求めるメソッド * @author hoge * @version 1.0 * @param width 横幅 * @param height 高さ * @return 面積 * @see <a href="http://xxx/">使い方</a> * @deprecated このメソッドは非推奨です。 */ public int getArea(int width, int height){ return width * height; } |
メモ
- Javadoc形式で書いたコメントは、javadocコマンドでJavadocを生成することができます。
