2009-04-02 7 views
21

私は非常によく説明されているインタフェースを生成しました。どのメソッドも独自のJavaDocを持っています。このインタフェースを実装するクラスは、ロジックにほとんど違いがありません。スーパーメソッドから新しいJavaDocを追加する

スーパークラスから既存のJavaDocにJavaDocを追加する方法を教えてください。キーワード

/** 
* {@inheritDoc} 
*/ 

のみ、現在のメソッドにスーパークラスのjavaDocを設定します。しかし、私はいくつかの単語を追加しようとすると、スーパーメソッドのJavaDocでは

/** 
* {@inheritDoc} 
* These value depends on... 
*/ 

のように、消えている誰もが、私は削除せず、スーパーメソッドのJavadocを更新することができる方法のアイデアを持っています。

EDIT:本当の答えは良いではないですブライアンアグニュー答え、にについて

;)

既存のメソッドを上書きしたいときにも、塗料のように、同じ問題を抱えていることができます()を使用して、外部から描画動作を初期化または処理する方法を説明したいと考えています。 これはインターフェイスの説明だけではありません。

+6

あなたが説明した問題は、Java 7では修正されているようです。提案されたコードはかなりうまく機能します。 – ubuntudroid

+0

大きな質問です。私は今日非常に役に立つ何かを学んだ。インタフェースを文書化するのに最適です。そして、すべての子はドキュメンテーションを継承し、独自の要素を追加します。たとえば、いくつかの例外が発生し、Javadocに単一の@ throwsを追加する必要がある実装です。 – Timmos

答えて

12

javadocに何かを追加する必要があるときは、何かを変更したと思います。 javadocをまったく同じ方法で記述するのは正しいでしょう。

/** 
* Enhanced swing paint for my cool component. 
* @see JButton#paint(); 
*/ 
@Override 
public void paint() { 
    super.paint(); 
    //my stuff 
} 
2

私はそれを行う直接のJavaDocイディオムを知らない。しかし、EclipseとIntelliJはスーパーJDocをつかみ、それを挿入することができます...あなたがsupr JDocを変更するかのように完璧ではありませんが、すべてのオーバーライドを再編集する必要がありますが、手作業でコピー・ペーストよりも優れています...

関連する問題