如何在javadoc中爲「添加參數」添加參數？

Question

我有一個java方法，它有兩個參數current，並且作爲敏捷過程的一部分，第三個參數也可以作爲此方法開發的一部分添加。

我加入的javadoc兩個參數：

/** 
* This method will simply calculate sum of two no.s 
* 
* @param a 
*   Number1 
* @param b 
*   Number2 
* @return a+b 
*/ 
public int sum(int a, int b) { 
    return a + b; 
} 

現在我想提一提，如果需要的話 [另外的3號S的情況下開發人員可以添加第三個參數（INT C）需要]

我可以做到這一點：

/** 
* This method will simply calculate sum of two no.s 
* Add third parameter (int c) if needed 
* 
* @param a 
*   Number1 
* @param b 
*   Number2 
* @return a+b 
*/ 

，但我不知道這是否是做的最好的做法。

那麼哪種方法最適合做呢？

Answer 1

那應該這樣做。

Javadoc應該記錄手頭的方法（或類或字段），就像你已經在做的那樣。它不能夠（即沒有特定的標記）指定對當前方法的允許修改，所以在這種情況下應該做的是狀態，在方法描述中以清楚明瞭的方式，添加參數。