2017-10-16 108 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警告車削以及