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

基本上我想问一下，在 getter 和 setter 方法的注释中使用 {@link} 是正确的吗？或者我应该在不使用 {@link} 的情况下使用普通评论？这种方式是否是 Java 标准？

Answer 1

实际上，我故意不使用 javadoc getter 和 setter，因为这样做不会增加任何值(value)——它们就是它们的本来面目……访问器方法。事实上，您将通过向它们添加 javadoc 来创建一种代码膨胀。

我只将 javadoc 放在非 getter/setter 上。