5

我想知道记录这个潜在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我具体关心的是andy属性及其各自的 getter 和 setter之间的重复，以及构造函数参数之间的重复。

并不是说我正在开发公共 API 或任何类似的东西，例如，我可以对某个变量进行一般性评论，然后让 getter 和 setter 具有相同的文本。我只是想避免在我自己的内部代码中重复注释。例如，有没有办法将构造函数getX()的参数与属性联系起来？int xx

谢谢

4

2 回答 2

1

例如，有没有办法将 getX() 和构造函数的 int x 参数绑定到 x 属性？

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

  • 根本不要评论getter（或setter）
  • 如果 X 需要上下文信息，并且如果它以某种方式代表类的（部分）状态，我只在类级 Javadoc 中记录它
于 2013-02-02T21:12:00.510 回答
0

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

于 2013-02-02T20:50:16.593 回答