enum型のコメント
JDK5.0から新しく加わったenum型。例えば，Webアプリケーションでよく出てくるスコープの種別について，以下のように定義したとする。
/**
* スコープの種別を持つ列挙型クラスです。
* @author yoichiro
*/
public enum Scope {
CONTEXT,
SESSION,
REQUEST,
PAGE
}
このコードでは，この列挙型自体のJavadocコメントを記述している。この状態でJavadocを出力しても，各識別子のコメントは出力されない。あれ？各識別子のコメントはどう書けばよいのだろうか？
答えは簡単で，以下のように書いてあげればよい。
/**
* スコープの種別を持つ列挙型クラスです。
* @author yoichiro
*/
public enum Scope {
/** コンテキスト */
CONTEXT,
/** セッション */
SESSION,
/** リクエスト */
REQUEST,
/** ページ */
PAGE
}
こうやって書いてあげることによって，ちゃんとJavadocにもコメントが反映されるようになる。
さらに，Eclipseのコード補完においても，ちゃんとコメントが認識されるようになる。
わかってしまえば何てことはないのだが，最初は「ん？」と思ってしまった。ググっても，なかなかコメント付きのenumのコードがないので，ご参考まで。
- Posted:
- 03.23.2006
- Category:
- Java
