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。