如何处理JavaDoc注释重复？

我想知道记录这个潜在的

点

类的最佳方式是：

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（）

和

intx

参数绑定到

x

属性

---

谢谢

一个明显的惯例是不为琐碎的getter编写JavaDoc注释

有没有办法将getX（）与构造函数的int x参数联系起来 例如，对x属性

不，我不知道。我所做的：

• 根本不要评论getter（或setter）
• 如果X需要上下文信息，并且如果它以某种方式表示类I的状态（部分），则只在类级Javadoc中记录它

---

我会将此作为评论发布，因为它并没有真正回答问题。当然。问题是，如果有人查看我的代码，可能会将鼠标悬停在getter上，并产生这样的印象：该数据段没有可用的信息，在某些情况下可能是不真实的。我通常不会在任何地方都放注释，所以在很多（大多数？）情况下，实际上可能没有可用的注释。这是我在JavaDoc中的一个问题-没有对宏、变量e.t.c.的真正支持，在某些情况下，我正在实现一个接口，我只想在从接口继承的JavaDoc中添加几个实现特定的语句。为什么我要复制整件事？@thkala，不要复制。使用

{@inheritardoc}

将继承的文档插入到适当的位置。@EngluseDelysium，如果这不是用于公共API，则根本不要编写任何Javadoc。这个类是如此的普通和琐碎，每个人都很容易理解。这样一个类中的Javadoc只会把源代码弄得乱七八糟。事实上，我甚至不会写getter，而是用它来代替。@MarcelStör：正如你所想象的，我不是以写点类为生的。这显然是一个简单的例子，让人们去吃水肿，毫无疑问-我想是的。然而，您的一个问题是“我想知道记录这个潜在点类的最佳方式是什么”。我的回答是：不要。至于你的具体问题，我把它变成了一个真实的答案。你所描述的基本上就是我一直在做的事情。我太天真了，相信有更聪明的方法来做事。