简单的 Getter/Setter 注释
你用什么惯例来评论 getter 和 setters?这是我在很长一段时间内一直想知道的事情,例如:
/**
* (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)部分写更多,以提供上下文,但对于大多数的getters/setters来说,措辞几乎完全相同。
我只是好奇,对于简单的getters/setters,是否可以只填写(a)部分或(b)部分。
你觉得怎么样?