@Documented java 中的注释

eclipse java annotations

2022-08-31 11:31:36

在java中注释的目的是什么？@Documented

我看到了文档，但无法从中得到太多。有人可以在一个明显的例子的帮助下指出来吗？

答案 1

@Documented是元注释。在定义注解时应用，以确保使用注解的类在其生成的 JavaDoc 中显示这一点。我没有看到它的太多用途，但这里有一个例子。前面的问题表明它在Eclipse中不会自动工作，但是我已经在Eclipse 3.6中进行了测试，无论我是否将注释附加到它们，我的注释都会出现在JavaDoc弹出窗口中。@Documented@Documented

下面是Spring的一个例子，它确保在JavaDoc中将事务方法标记为这样：

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Transactional {

答案 2

如果我们的某些注释（例如）是，那么对于每个具有该注释的类，javadoc生成的文本将包含文本，作为对注释的引用。@InWork@Documented@InWork@InWork

注解：

@Documented
@Inherited  // for descenders of the annotation to have the @Documented feature automatically
@Retention(RetentionPolicy.RUNTIME) // must be there
public @interface InWork {
    String value();
}

带注释的目标：

/**
 * Annotated class.
 */
@InWork(value = "")
public class MainApp {...}

javadoc 文本：

enter image description here

因此，您必须决定是否应该在javadoc文本中显示注释，如果是，请将其设置为它。@Documented

以上信息摘自 Oracle 文档。

请注意，在Eclipse中，您将在javadoc生成的文本中看到所有注释，它们是否@Documented。

对于4.3版本，它仍然是正确的。