Question

我想知道记录这个潜在的Point课程的最佳方法是：

public class Point {
    /* the X coordinate of this point */
    private int x;
    /* the Y coordinate of this point */
    private int y;

    public Point(int x, int y) {
        this.x = x;
        this.y = y;
    }

    public int getX() {
        return x;
    }

    public int getY() {
        return y;
    }
}

我的具体关注点在于x和y属性及其各自的getter和setter之间的重复，以及构造函数参数的重复。

并不是我正在开发一个公共API或类似的东西，对我来说，对一些变量进行一般性评论然后让getter和setter只有相同的文本也没问题。我只想避免在我自己的内部代码中重复注释。例如，有没有办法将getX()和构造函数的int x参数绑定到x属性？

由于

Answer 1

有没有办法绑定getX（）和构造函数的int x参数例如，对于x属性？

不，不是我知道的。我做什么：

不要评论getter（或setters）
如果X需要上下文信息，如果它以某种方式表示类的一部分状态，我只在类级Javadoc中记录它

Answer 2

一个明显的约定是不会为琐碎的getter编写JavaDoc注释。

如何处理JavaDoc注释重复？

2 个答案: