2009-07-22 7 views
17

私のプロジェクトでは、javadoc APIのドキュメントに表示するのに非常に便利ないくつかのアノテーションを使用しています。注釈を文書化するためのjavadocツールを入手する方法はありますか?

生成されたjavadocにアノテーションを挿入する簡単な方法を知っている人はいますか?私は自分自身のjavadocプラグインを書いたくありません。そこに解決策はありますか?

答えて

25

java.lang.annotation.Documented

が型を持つ注釈がjavadocおよび同様のツールによってデフォルトでドキュメント化されることを示し参照してください。この型は、注釈がクライアントによって注釈付き要素の使用に影響を及ぼす型の宣言に注釈を付けるために使用する必要があります。型宣言にDocumentedという注釈が付いている場合、その注釈は注釈付き要素のパブリックAPIの一部になります。

例:

import java.lang.annotation.Documented; 

@Documented 
public @interface MyAnnotation { 
} 
関連する問題