抽象クラスを継承するコンストラクタをjavadocする方法

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がトトクラスのメソッドへのリンクですそれは基本的に私が望むものです。しかし、ネットビーンズでは、numberのために@paramを追加するように言われていますが、これはTotoのものと同じものです。 これは、既にTotoで定義されているので何番の番号を再定義したくないのですが、Netbeansが@paramタグを追加する必要があるとも言いません。

私が持っていたアイディアは、TotoのmyVariableにjavadocを追加し、ShortTotoに@param番号タグを追加してリンクすることでした。しかし、この場合、myVariableのドキュメントへのリンクがありますが、定義を取得するだけです。この場合、「定義された値」。

私は十分にはっきりしていないと、私は事前に謝罪します。私に質問をするのをためらうことはありません。私はより明確にしようとします。

Answer 1

これは、他の開発者のためのAPIドキュメントであれば、私の個人的な好みは、基本クラスからの

• コピー（ドキュメントのDRY違反！）
• 使用{@link xxxx}ドキュメンテーションタグ
のいずれかになります

この問題は無視してください。

それはちょうどあなたの自己のために私は限り、あなたが探しているものかもしれないだけでなく