Java 中的@param 注解

在 Java 中，注解是表示元数据的标签，它附有类、接口、方法等，用来表示 JVM 和 Java 编译器可以使用的一些特殊类型的附加信息。

@param 注释是生成文档的 javadoc 使用的特殊格式注释。

在本教程中，我们将讨论注释@param 在 Java 中的工作原理。

如上所述，@param 是 javadoc 使用的一种特殊类型的格式注释，用于生成文档。它表示方法可以接收的参数（或多个参数）的描述。

还有像@return 和@see 这样的注释来描述返回值和相关信息。

如果具体用于任何方法，该注解不会以任何方式影响其工作方法。它仅用于创建该特定方法的文档。我们可以将此注解放在类、方法、字段、构造函数、接口等之前。

使用此注解的优势在于，通过使用此注解，我们允许简单的 Java 类（可能包含属性和一些自定义 javadoc 标签）作为代码生成的简单元数据描述。

例如，

/*
    *@param number
    *@return integer
*/
public int main number(int num) {
    // if number is less than 5, square it
    if(num < 5) {
        num = num * num;
    } else {
        // else add the number to itself
        num = num + num;
    }
    return num;
}

在上面的例子中，方法 number() 将作为其余代码的元数据。每当代码重用此方法时，IDE 都会显示此方法接受的参数。在这种情况下，接受一个参数，即一个名为 num 的整数。此外，方法的返回类型，在本例中为 int。