Question

我试图以最干净的方式记录我的Java代码，而不必多次复制内容。这是我所得到的一个例子，然后我会解释我想要的东西：

public abstract class Toto <S extends Number>{

    /**
    * Defined value
    */
    protected S myVariable;
    protected String myWord;

    /**
    * Constructor 1
    */
    protected Toto(){
        this.myWord = "a";
    }

    /**
    * Constructor 2
    * @param number something
    */
    protected Toto(S number){
        this.myVariable = number;
    }

    ...
}

public class ShortToto extends Toto<Short>{

    public subToto(){
        super();
    }

    /**
    * {@link Toto#Toto(Number)}
    */
    public subToto(Short number){
        super(number);
    }
    ...
}

我从中得到的ShortToto javadoc是Toto类中方法的链接，这基本上就是我想要的。但是，在netbeans中，我被告知要添加@param作为数字，但它与Toto中的相同。我不想重新定义数字，因为它已在Toto中定义，但我也不知道Netbeans告诉我需要添加@param标记。

我的想法是在Toto中为myVariable添加一个javadoc，在ShortToto中添加一个@param数字标签并链接它。但是，在这种情况下，我获得了myVariable doc的链接，而我只想获得定义。在这种情况下＆＃34;定义值＆＃34;。

我希望我能够清楚，如果没有，我会事先道歉，不要犹豫向我提问，我会更加清楚。

Answer 1

如果这是其他开发人员的API文档，那么我个人的偏好是

从基类复制到（文档中的DRY违规！）
使用{@link xxxx}文档标记

然后忽略这个问题。

如果它只是为了你自己，我也会转到IDE警告

如何javadoc扩展抽象类

1 个答案: