getter和setter方法的Java注释

Question

我的问题是我应该评论如下:

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

基本上我想问一下,使用{@link}评论getter和setter方法是否正确？或者我应该使用正常评论而不使用{@link}？这种方式是不是java标准？

Answer 1

实际上,我故意不要使用javadoc getter和setter,因为你没有通过这样做来增加任何价值 - 它们就是它们......存取方法.事实上,你会通过向它们添加javadoc来创建一种代码膨胀.

我只把javadoc放在非getter/setter上.

Answer 2

惯例问题。因组织而异。以前，我们被要求不必费心评论 getter 和 setter，只要它的作用显而易见即可。这与没有 的注释相同{@link}。

目前，我们添加了{@link}之前编写的代码已经具有此约定。