Java注释是在代码中添加注释信息，用于解释代码的功能、实现方法、输入输出等信息。注释对于代码的可读性和维护性非常重要，能够帮助其他开发者快速理解代码的含义和作用。本文将介绍常用的Java注释模板和使用方法，并通过代码示例详细阐述。

1. 常用的Java注释模板

在Java中，常用的注释模板包括：类注释、方法注释、成员变量注释和常量注释等。下面将逐一介绍这些注释模板及其使用方法。

1.1 类注释

类注释用于解释一个类的作用、设计意图、实现方法等信息。一个完整的类注释通常包括以下内容：

  • 类的作用和功能
  • 类的设计意图和背景
  • 类的作者和创建日期
  • 类的修改历史
  • 类的使用方法和注意事项

一个典型的类注释示例如下所示：

/**
 * 类名：Calculator
 * 功能：实现简单的加减乘除运算
 * 作者：John
 * 创建日期：2021-01-01
 * 修改历史：
 *  2021-01-02 修改了加法方法
 *  2021-01-03 修改了除法方法
 *  使用方法：
 *  Calculator calculator = new Calculator();
 *  int result = calculator.add(1, 2);
 *  注意事项：
 *  除数不能为0
 */
public class Calculator {
    // 类的成员变量和常量
    // ...
    
    // 类的方法
    // ...
}

1.2 方法注释

方法注释用于解释一个方法的功能、输入输出、异常和使用方法等信息。一个完整的方法注释通常包括以下内容：

  • 方法的功能和作用
  • 方法的参数说明
  • 方法的返回值说明
  • 方法的异常说明
  • 方法的使用方法和注意事项

一个典型的方法注释示例如下：

/**
 * 方法名：add
 * 功能：实现两个整数的加法运算
 * 参数：
 *      int a: 第一个加数
 *      int b: 第二个加数
 * 返回值：
 *      int: 加法运算的结果
 * 异常：
 *      无
 * 使用方法：
 *      Calculator calculator = new Calculator();
 *      int result = calculator.add(1, 2);
 */
public int add(int a, int b) {
    return a + b;
}

1.3 成员变量注释

成员变量注释用于解释一个类的成员变量的作用、类型和取值范围等信息。一个完整的成员变量注释通常包括以下内容：

  • 成员变量的作用和功能
  • 成员变量的类型和取值范围
  • 成员变量的默认值和初始化方式

一个典型的成员变量注释示例如下：

/**
 * 成员变量：userName
 * 作用：保存用户的姓名
 * 类型：String
 * 取值范围：不为空字符串
 * 默认值：空字符串
 */
private String userName = "";

1.4 常量注释

常量注释用于解释一个常量的作用、取值范围和使用方法等信息。一个完整的常量注释通常包括以下内容：

  • 常量的作用和功能
  • 常量的取值范围和取值限制
  • 常量的使用方法和注意事项

一个典型的常量注释示例如下：

/**
 * 常量：MAX_VALUE
 * 作用：表示最大值
 * 取值范围：大于等于0
 * 使用方法：int maxValue = Constants.MAX_VALUE;
 */
public static final int MAX_VALUE = 100;

2. Java注释的使用方法

在Java中，添加注释的方法非常简单，只需要在代码前面添加//或/* ... */即可。下面将通过实际代码示例演示Java注释的使用方法。

2.1 添加类注释

在类的定义之前，使用/** ... */的方式添加类注释。示例如下：

/**
 * 类名：Calculator