当前位置：首页 > Java

java 如何收集备注

2026-03-22 08:34:42Java

在 Java 中收集备注的方法

使用注释（Comments）

Java 支持三种注释方式，适合在代码中添加备注：

java 如何收集备注

单行注释：以 // 开头，适用于简短说明。
```
// 这是一个单行注释  
int x = 10;  
```

多行注释：用 /* ... */ 包裹，适合较长的说明。

/*  
这是一个多行注释，  
可以跨越多行。  
*/

文档注释：以 / ... */ 包裹，用于生成 Javadoc。

/  
 * 计算两个数的和。  
 * @param a 第一个加数  
 * @param b 第二个加数  
 * @return 两数之和  
 */  
public int add(int a, int b) {  
    return a + b;  
}

使用字符串或配置文件

字符串变量：将备注存储在字符串中，便于动态管理。

String remark = "这是一个动态备注";  
System.out.println(remark);

外部配置文件（如 .properties 或 .yaml）：

# config.properties  
remark=这是一个配置文件的备注

Properties props = new Properties();  
props.load(new FileInputStream("config.properties"));  
String remark = props.getProperty("remark");

使用注解（Annotations）

通过自定义注解存储结构化备注信息：

java 如何收集备注

@Retention(RetentionPolicy.RUNTIME)  
public @interface Remark {  
    String value() default "";  
}  

// 使用注解  
@Remark("这是一个方法级别的备注")  
public void process() {  
    // 方法逻辑  
}

日志记录

通过日志框架（如 SLF4J）记录备注信息：

import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  

public class Main {  
    private static final Logger logger = LoggerFactory.getLogger(Main.class);  

    public static void main(String[] args) {  
        logger.info("这是一个日志备注");  
    }  
}

数据库存储

将备注存入数据库表字段，适用于需要持久化的场景：

// 使用 JDBC 示例  
String sql = "INSERT INTO remarks (content) VALUES (?)";  
try (PreparedStatement stmt = connection.prepareStatement(sql)) {  
    stmt.setString(1, "这是一个数据库存储的备注");  
    stmt.executeUpdate();  
}

根据需求选择合适的方式，注释适合代码内说明，而外部存储或日志适合动态或持久化场景。