@Target、@Retention、@Documented、@Inherited注解的超详细分析

@Target

@Target(ElementType.ANNOTATION_TYPE) 的@Target注解是Java中用于注解定义的元注解之一，它用于指定被定义的注解可以应用到哪些其他注解上。

java.lang.annotation.ElementType 是Java中的一个枚举类型，它用于指定注解可以应用的目标元素类型。以下是 ElementType 的各个参数的解释：

1. ElementType.ANNOTATION_TYPE:

   表示注解可以应用到其他注解上，允许创建复合注解。

        示例：

@Target(ElementType.ANNOTATION_TYPE)
public @interface MyMetaAnnotation {
    // 元注解的定义
}

@MyMetaAnnotation
public @interface MyCustomAnnotation {
    // 自定义注解的定义
}

1. ElementType.CONSTRUCTOR:

   表示注解可以应用到构造函数上。

2. ElementType.FIELD:

   表示注解可以应用到域（字段）上，即类的成员变量。

3. ElementType.LOCAL_VARIABLE:

   表示注解可以应用到局部变量上，通常在方法内部定义的变量。

4. ElementType.METHOD:

   表示注解可以应用到方法上。

5. ElementType.PACKAGE:

   表示注解可以应用到包上，通常用于模块化或包级别的注解。

6. ElementType.PARAMETER:

   表示注解可以应用到方法参数上。

7. ElementType.TYPE:

   表示注解可以应用到类、接口、枚举或注解类型上。

@Retention

@Retention(RetentionPolicy.RUNTIME) 的@Retention注解是Java中用于注解定义的元注解之一，它用于指定注解的保留策略，即注解在运行时是否可用。

具体来说，@Retention 元注解可以具有以下三个保留策略参数（RetentionPolicy）：

1. RetentionPolicy.SOURCE:

   注解仅保留在源代码中，不会包含在编译后的类文件和运行时中。这种注解通常用于编译时的工具，如代码检查工具。

2. RetentionPolicy.CLASS:

   注解会包含在编译后的类文件中，但在运行时不可用。这意味着你可以在编译时读取这些注解，但无法在运行时访问它们。这种保留策略通常用于处理字节码的工具。

3. RetentionPolicy.RUNTIME:

   注解会保留在编译后的类文件中，并在运行时可用。这意味着你可以在运行时通过反射机制访问和处理这些注解。

通常情况下，如果你希望在运行时能够访问和处理注解，你应该使用 @Retention(RetentionPolicy.RUNTIME)。这使得注解可以在运行时用于元数据处理、反射、自定义注解处理器等任务。例如，Spring框架的依赖注入和AOP功能就广泛使用了运行时保留的注解。

@Documented

@Documented 是Java中的一个元注解，用于指示自定义注解是否应该包含在生成的文档（Java文档）中。具体来说，当一个注解被标记为 @Documented 时，它的信息会包括在生成的文档中，以便文档工具和IDE可以显示该注解的信息。

通常情况下，大多数自定义注解不包含在生成的文档中，因为它们主要用于编译时或运行时的元数据处理，而不是文档注释。但是，如果你希望某个自定义注解的信息包括在文档中，可以使用 @Documented 元注解。

import java.lang.annotation.Documented;

@Documented
public @interface MyDocumentedAnnotation {
    // 注解定义
}

在上面的示例中，@Documented 用于标记自定义注解 MyDocumentedAnnotation，使其信息包括在生成的Java文档中。这样，如果你创建了文档或使用IDE查看该注解，你将能够看到有关该注解的信息。这对于具有特定文档要求的自定义注解非常有用。

通常使用javadoc和类似工具生成文档。

javadoc

Javadoc（Java Documentation）是一种用于生成Java代码文档的工具，它能够从Java源代码文件中提取注释并生成HTML文档，以便开发者和用户能够查看、理解和使用Java类、接口、方法等的文档。

以下是Javadoc的一些关键特点和用法：

1. 文档注释： Javadoc使用特定格式的注释来生成文档。文档注释通常以/**开始，然后在注释内包含一些标签和描述性文本，以描述类、方法、字段等的用途和行为。

2. 标签： Javadoc注释包含各种标签，用于描述不同部分的文档，例如@param用于描述方法参数，@return用于描述方法的返回值，@throws用于描述异常，等等。

3. HTML输出： Javadoc生成的文档通常是HTML格式，这使得文档易于阅读和导航。生成的文档包括类的层次结构、继承关系、方法和字段的描述，以及相关的注释和标签。

4. 命令行工具： Javadoc提供一个命令行工具，开发者可以使用它来生成文档。通常，你可以运行类似于javadoc MyJavaFile.java的命令，其中MyJavaFile.java是包含Javadoc注释的Java源代码文件的名称。

5. 集成到IDE： 现代集成开发环境（IDE）通常集成了Javadoc生成工具，允许开发者通过IDE的界面生成和查看文档。

示例 Javadoc 注释：

/**
 * This is an example class.
 * It demonstrates the usage of Javadoc comments.
 *
 * @author John Doe
 * @version 1.0
 */
public class ExampleClass {
    /**
     * This is a sample method that adds two numbers.
     *
     * @param a The first number.
     * @param b The second number.
     * @return The sum of a and b.
     */
    public int addNumbers(int a, int b) {
        return a + b;
    }
}

在上面的示例中，我们有一个包含Javadoc注释的Java类和方法。这些注释包括作者信息、版本号、类的描述、方法的描述、参数描述和返回值描述。

要生成Javadoc文档，你可以使用javadoc命令或IDE中的集成工具。生成的文档将提供有关类和方法的详细信息，以帮助其他开发者了解和使用你的代码。

@Inherited

@Inherited 是Java中的一个元注解，它用于指示一个自定义注解是否应该被其子类继承。具体来说，当一个注解被标记为 @Inherited 时，如果一个类使用了该注解，它的子类也将自动继承该注解，除非子类显式地覆盖了该注解。

@Inherited 主要用于类继承的情况，对于接口或方法的继承不适用。

以下是一个示例：

import java.lang.annotation.Inherited;

@Inherited
public @interface MyInheritedAnnotation {
    // 注解定义
}

@MyInheritedAnnotation
public class ParentClass {
    // 父类
}

public class ChildClass extends ParentClass {
    // 子类
}

在上面的示例中，我们定义了一个自定义注解 MyInheritedAnnotation 并将其标记为 @Inherited。然后，我们在 ParentClass 类上使用了该注解。由于 MyInheritedAnnotation 是 @Inherited 的，所以 ChildClass 类也继承了 MyInheritedAnnotation，即使没有显式在 ChildClass 上使用该注解。

这对于一些框架和库中的元数据处理非常有用，因为它们可以自动继承并处理注解，而不需要在每个子类上重复应用相同的注解。