记录getter和setter

Question

对于简单的getter/setter,如下所示,记录它的最佳方法是什么？

public float getPrice()
{
    return price;
}

我对编码标准非常严格,因此我的IDE会警告我任何未记录的公共/受保护方法.

选项1:

/**
 * Get the price field.
 * 
 * @return
 */

选项2:

/**
 * @return Price
 */

或者根本不记录？

Answer 1

我会写最少的内容以保持 linter 安静。如果 getter/setter 获取/设置的内容很明显，我会使用一些复制粘贴文档来清楚地表明没有发生任何奇怪的事情：

/**
 * Simple getter.
 * @return Price
 */

我个人认为太多的 getter 和 setter 是一种代码味道，因为这可能表明您没有在正确的抽象级别提供操作（这显然并不总是正确的，但这是一个经验法则）。