Java Doc 固定的 Tag
Java Doc 是 Java 编程语言中的一种注释风格，用于生成 API 文档。在 Java Doc 注释中，可以使用一些固定的 Tag 来提供特定的信息，帮助开发者更好地理解代码的含义。在本文中，我们将介绍几个常用的 Java Doc 固定的 Tag，并给出相应的代码示例。
@param
@param Tag 用于描述方法的参数。通过指定参数名称和参数说明，可以帮助其他开发者更好地理解方法的使用方式。
/**
* 计算两个整数的和
*
* @param num1 第一个整数
* @param num2 第二个整数
* @return 两个整数的和
*/
public int add(int num1, int num2) {
return num1 + num2;
}
在上面的例子中，@param Tag 描述了两个参数 num1 和 num2，并给出了相应的说明。在生成的 API 文档中，其他开发者可以清晰地了解到这个方法接受两个整数作为参数，并返回它们的和。
@return
@return Tag 用于描述方法的返回值。通过指定返回值的类型和说明，可以帮助其他开发者更好地理解方法的返回结果。
/**
* 计算两个整数的差
*
* @param num1 被减数
* @param num2 减数
* @return 两个整数的差
*/
public int subtract(int num1, int num2) {
return num1 - num2;
}
在上面的例子中，@return Tag 描述了返回值的类型是一个整数，并给出了相应的说明。在生成的 API 文档中，其他开发者可以清晰地了解到这个方法返回两个整数的差。
@throws
@throws Tag 用于描述方法可能抛出的异常。通过指定异常类型和说明，可以帮助其他开发者更好地理解方法的异常情况。
/**
* 除法运算
*
* @param num1 被除数
* @param num2 除数
* @return 两个整数的商
* @throws ArithmeticException 如果除数为0
*/
public int divide(int num1, int num2) throws ArithmeticException {
if (num2 == 0) {
throw new ArithmeticException("除数不能为0");
}
return num1 / num2;
}
在上面的例子中，@throws Tag 描述了可能抛出的异常类型是 ArithmeticException，并给出了相应的说明。在生成的 API 文档中，其他开发者可以清晰地了解到这个方法可能会抛出除数为0的异常。
@see
@see Tag 用于引用其他相关的类、方法或者文档。通过指定引用的目标，可以帮助其他开发者更好地了解相关内容。
/**
* 计算平方根
*
* @param num 输入的数字
* @return 平方根
* @throws IllegalArgumentException 如果输入的数字小于0
* @see Math#sqrt(double)
*/
public double sqrt(double num) throws IllegalArgumentException {
if (num < 0) {
throw new IllegalArgumentException("输入的数字不能小于0");
}
return Math.sqrt(num);
}
在上面的例子中，@see Tag 引用了相关的 Math#sqrt(double) 方法，表示这个方法是通过调用 Math 类的平方根方法来实现的。在生成的 API 文档中，其他开发者可以通过点击链接查看被引用的方法的具体说明。
通过使用上述固定的 Tag，可以使生成的 API 文档更加清晰、易读。开发者可以通过阅读 API 文档来了解方法的参数、返回值、异常情况以及其他相关内容，帮助他们更好地使用代码。
代码示例
/**
* 计算阶乘
*
* @param n 非负整数
* @return 阶乘结果
* @throws IllegalArgumentException 如果输入的数字小于0
*/
public int factorial(int n) throws IllegalArgumentException {
if (n < 0) {
throw new IllegalArgumentException("
