java获取注释 /**-CFANZ编程社区

Java获取注释 /**

在Java开发中，注释是用来解释代码的特殊标记。它们不会被编译器解释，也不会对程序的运行结果产生影响。然而，在某些情况下，我们可能需要通过代码获取注释的内容。本文将介绍如何使用Java获取以 / ** 开头的注释。

注释类型

在Java中，有三种类型的注释：

单行注释: 以 // 开头，用于在一行中注释代码。
多行注释: 以 /* 开头，以 */ 结尾，用于注释多行代码。
文档注释: 以 / ** 开头，以 */ 结尾，用于生成文档。

在本文中，我们将重点关注文档注释。

文档注释

文档注释是一种特殊的注释类型，用于生成程序文档。它以 /** 开头，以 */ 结尾，可以包含多行注释内容。

/**
 * 这是一个示例文档注释。
 * 它可以包含多行注释内容。
 */
public class MyClass {
    // ...
}

使用反射获取注释内容

要获取文档注释的内容，我们可以使用Java的反射机制。反射允许我们在运行时检查和操作类、方法、字段等。

下面是一个示例，演示如何使用反射获取类的文档注释：

import java.lang.reflect.Field;

public class Main {
    public static void main(String[] args) throws NoSuchFieldException {
        Class<MyClass> clazz = MyClass.class;
        Field field = clazz.getField("myField");
        
        String comment = field.getAnnotation(MyAnnotation.class).value();

        System.out.println(comment);
    }
}

class MyClass {
    /**
     * 这是一个字段注释。
     */
    @MyAnnotation("这是一个注解")
    public String myField;
}

@interface MyAnnotation {
    String value();
}

在上面的示例中，我们定义了一个 MyAnnotation 注解，用于给字段添加注释。在 MyClass 类中，我们应用了 MyAnnotation 注解，并给注解的 value 属性赋值。

在 Main 类中，我们使用反射获取了 myField 字段，并获取了它的注解内容。我们通过 field.getAnnotation(MyAnnotation.class) 获取了 MyAnnotation 注解的实例，并通过 .value() 方法获取了注解的值。

运行以上代码，我们将会看到输出的结果为：这是一个注解，这是 myField 字段注解中定义的值。