Простой Getter / Setter комментарии
Какое соглашение вы используете, чтобы комментировать геттеры и сеттеры? Это то, что я удивляюсь довольно давно, например:
<code>/** * (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(); </code>
Я всегда нахожу, что я в значительной степени пишу одно и то же для 1a / b и 2a / b, что-то вроде 1a) Устанавливает зарплату сотрудника, 1b) оклад сотрудника. Это просто кажется излишним. Теперь я мог бы увидеть что-то более сложное, вы могли бы написать больше в (а) частях, чтобы дать контекст, но для большинства получателей / установщиков там формулировка почти точно такая же.
Мне просто любопытно, если для простых получателей / установщиков нормально заполнять только часть (a) ИЛИ часть (b).
Как вы думаете?