当前位置：首页 > Java

java如何显示注释

2026-03-21 23:18:42Java

显示注释的方法

在Java中，注释不会被编译器执行，但可以通过工具或代码解析提取注释内容。以下是几种显示注释的方法：

使用反射获取类或方法的注释

通过反射API可以获取类、方法或字段上的注解（Annotation），但标准注释（如//或/* */）无法通过反射直接获取。若需获取注解内容，示例如下：

java如何显示注释

import java.lang.annotation.*;

@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation {
    String value();
}

@MyAnnotation("示例注解")
public class Test {
    public static void main(String[] args) {
        MyAnnotation annotation = Test.class.getAnnotation(MyAnnotation.class);
        System.out.println(annotation.value()); // 输出: "示例注解"
    }
}

使用JavaDoc工具生成文档

通过javadoc命令可以提取代码中的文档注释（/ */）并生成HTML文档：

javadoc -d doc -author -version YourClass.java

生成的文档会包含所有/ */注释内容。

java如何显示注释

使用第三方库解析源代码

工具如JavaParser可以解析Java源代码并提取注释：

添加依赖（Maven）：

<dependency>
 <groupId>com.github.javaparser</groupId>
 <artifactId>javaparser-core</artifactId>
 <version>3.25.1</version>
</dependency>

解析代码示例：


import com.github.javaparser.StaticJavaParser;
import com.github.javaparser.ast.CompilationUnit;
import com.github.javaparser.ast.comments.Comment;

public class CommentExtractor { public static void main(String[] args) { String code = "// 单行注释\npublic class A { / 块注释 / }"; CompilationUnit cu = StaticJavaParser.parse(code); cu.getAllComments().forEach(Comment::toString); } }



#### 使用IDE查看注释
大多数IDE（如IntelliJ IDEA、Eclipse）支持直接查看代码中的注释，无需额外操作。通过快捷键或悬停鼠标即可显示注释内容。

### 注意事项
- 普通注释（`//`、`/* */`）在编译后会被丢弃，仅文档注释（`/ */`）可通过工具提取。
- 若需运行时访问注释，必须使用注解（Annotation）并设置`@Retention(RetentionPolicy.RUNTIME)`。