Как добавить параметр «Добавить параметр, если необходимо» для метода в javadoc?

Question

У меня есть метод java, который имеет два значения параметра, и в качестве части гибкого процесса третий параметр также может быть добавлен как часть разработки этого метода.

Я добавил 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 с) при необходимости [В случае добавления 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 должен документировать метод (или класс или поле) под рукой, как вы уже делаете. Он не способен (т. Е. Не имеет специальных разметок), указав разрешенные модификации текущего метода, поэтому в этом случае необходимо сделать это простым и ясным образом в описании метода, возможность добавления параметр к нему.