4

私の質問は、次のようにコメントする必要があります。

/**
     * Getter for {@link #auto_key}
     * @return {@link #auto_key}
     */
    public String getAuto_key() {
        return auto_key;
    }
    /**
     * Setter for {@link #auto_key}
     * @param auto_key the {@link #auto_key} to set
     */
    public void setAuto_key(String auto_key) {
        this.auto_key = auto_key;
    }

基本的に質問したいのですが、getter と setter メソッドのコメントで {@link} を使用するのは正しいですか? または {@link} を使用せずに通常のコメントを使用する必要がありますか? そして、この方法はJava標準ですか？

4

6 に答える 6

9

実際には、javadoc の getter と setter を意図的に使用していません。そうすることで値を追加していないからです。それらは、アクセサ メソッドです。実際、javadoc を追加することで、一種のコードの膨張を作成することになります。

非ゲッター/セッターにのみjavadocを配置します。

于 2012-04-06T06:37:20.167 に答える
0

メソッドがゲッターまたはセッターのように見えるが、異なる動作をカプセル化している場合を除き、ゲッターまたはセッターを説明するコメントを入れないでください。

于 2012-04-06T06:55:33.253 に答える
0

慣例の問題。組織によって異なります。以前は、getter と setter が何をするかが明らかである限り、わざわざコメントしないように求められていました。なしのコメントと同じ{@link}です。

{@link}現在、以前に記述されたコードには既にこの規則があるため、追加します。

于 2012-04-06T06:37:14.457 に答える