2017-10-16 74 views
-1

我想尽可能以最干净的方式记录我的Java代码,而不必复制东西多次。下面是我有什么例子,然后我会解释我想要什么:如何javadoc扩展抽象类的构造函数

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我从得到的是在托托类方法的链接这基本上是我想要的。但是,在netbeans中,我被告知要为数字添加@参数,但它与托托中的一样。 我不想重新定义什么数字,因为它已经在Toto中定义了,但我也不知道Netbeans告诉我需要添加@param标签。

我的想法是在Toto中为myVariable添加一个javadoc,在ShortToto中添加一个@param数字标签并将其链接起来。但是,在这种情况下,我获得了myVariable文档的链接,但我只想获得定义。在这种情况下,“定义值”。

我希望我很清楚,如果不是,我提前道歉,不要犹豫,问我的问题,我会尽量做得更清楚。

+1

{} @inheritdoc可能是你在找什么去了。我使用Eclipse,但很可能可以在设置中关闭javadoc警告 –

回答

-1

如果这是对其他开发人员的API文档,然后我的个人喜好将是要么

  • 复制到从基类(以干违反文件!)
  • 使用{@link xxxx}文档标签

然后忽略问题。

如果它只是为你的自我我会尽可能的IDE警告车削以及