Idea开发代码注释规范

规范

1. 类注释：每个类都应该有一个简短的注释，描述这个类的用途和主要功能。注释应该放在类的声明之前，使用JavaDoc格式。

/**
 * 这是一个示例类，用于演示如何编写类注释。
 */
public class ExampleClass {
   
   
    // ...
}

2. 方法注释：每个方法也应该有一个简短的注释，描述这个方法的功能、输入参数、返回值以及可能抛出的异常。注释应该放在方法声明之前，使用JavaDoc格式。

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

3. 变量注释：对于复杂的变量或需要解释的变量，应该在声明时添加注释。注释应该简洁明了，说明变量的作用和含义。

/**
 * 存储用户的名字
 */
private String userName