javadocのメソッドの "必要に応じてパラメータを追加"する方法

Question

私は、2つのパラメータの電流を持つjavaメソッドを持っています。アジャイルプロセスの一部として、このメソッドに開発の一部として3番目のパラメータを追加することもできます。

私は2つのパラメータの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は、すでに行っているように、手近なメソッド（またはクラスまたはフィールド）を文書化することになっています。現在のメソッドに対して許可された変更を指定することはできません（つまり、これには特別なマークアップはありません）。そのため、この場合は、メソッドの説明では明白で明確な方法で、それに対するパラメータ。