[解決済み] シンプルなゲッター/セッターのコメント

質問

ゲッターとセッターのコメントにはどのような規約があるのでしょうか？ これは、例えば、私がかなり長い間疑問に思っていたことです。

/**
 * (1a) what do you put here?
 * @param salary (1b) what do you put here?
 */
public void setSalary(float salary);

/*
 * (2a) what do you put here?
 * @return (2b)
 */
public float getSalary();

私はいつも、1a/bと2a/bについて、1a)従業員の給料を設定、1b)従業員の給料のような、全く同じことを書いていることに気づきます。 これは冗長に見えます。 もっと複雑なものであれば、文脈を示すために(a)の部分をもっと書くかもしれませんが、世の中にあるゲッター/セッターの大部分では、表現はほとんど同じなのです。

単純なゲッター/セッターの場合、(a)の部分と(b)の部分のどちらか一方だけを記入すればいいのかどうか、ちょっと気になりますね。

あなたはどう思いますか？

どのように解決するのですか？

通常、セッターの場合はparamの部分、ゲッターの場合は@returnの部分を埋めるだけです。

/**
 * 
 * @param salary salary to set (in cents)
 */
public void setSalary(float salary);

/**
 * @return current salary (in cents, may be imaginary for weird employees)
 */
public float getSalary();

そうすれば、javadocチェックツール（Eclipseの警告など）はきれいに表示され、重複がなくなります。