简单的Getter / Setter评论

Question

您使用什么约定来评论获取方法和设置方法？这是我很长时间以来一直想知道的事情：

/**
 * (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）部分是否可以。

你怎么看？

Answer 1

我通常只为setter填充param部分，为getter填充@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的警告）将变得干净利落，并且没有重复。