如何在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应该记录手头的方法（或类或字段），就像你已经在做的那样。它不能够（即没有特定的标记）指定对当前方法的允许修改，所以在这种情况下应该做的是状态，在方法描述中以清楚明了的方式，添加参数。