如何提及＆＃34;必要时添加参数＆＃34;对于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;
}

现在我想提一下，如果需要，开发人员可以添加第三个参数（int c） [如果需要添加3个no.s]

我可以通过以下方式完成：

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