2009-07-22 64 views
17

在我的项目中,我们使用了很多注释,这些注释在javadoc API文档中非常有用。有没有办法让javadoc工具来记录注释?

有谁知道一个简单的方法来包含生成的javadoc中的注释?我不想写我自己的javadoc插件。那里有解决方案吗?

回答

25

java.lang.annotation.Documented

指示某一类型的注释将通过默认javadoc和类似的工具来记录。这种类型应该用于注释注释影响客户使用注释元素的类型的声明。如果类型声明使用Documented进行注释,则其注释将成为注释元素的公共API的一部分。

实施例:

import java.lang.annotation.Documented; 

@Documented 
public @interface MyAnnotation { 
} 
相关问题