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;
    }
}

私の具体的な懸念は、xandy属性とそれぞれのゲッターとセッターの間の繰り返し、およびコンストラクターの引数にあります。

私がパブリック API などを開発しているわけではありません。たとえば、変数に関する一般的なコメントがあり、ゲッターとセッターに同じテキストを持たせることは問題ありません。自分の内部コードでコメントの繰り返しを避けたいだけです。たとえば、コンストラクターgetX()のint x引数を属性に結び付ける方法はありますか?x

ありがとう

4

2 に答える 2

1

たとえば、getX（）とコンストラクターのint x引数をx属性に関連付ける方法はありますか？

いいえ、私が知っていることではありません。私がすること：

  • ゲッター（またはセッター）にはコメントしないでください
  • Xがコンテキスト情報を必要とし、それがクラスの状態（の一部）を何らかの形で表す場合は、クラスレベルのJavadocでのみ文書化します。
于 2013-02-02T21:12:00.510 に答える
0

明らかな慣例の1つは、些細なゲッターに対してJavaDocコメントを記述しないことです。

于 2013-02-02T20:50:16.593 に答える