java - 抽象クラスを拡張する JavaDoc クラスを使用する必要がありますか?

Question

抽象クラス「Work」を拡張するクラス「MyWork」を書いているとします。ここで、"MyWork" で必要なすべてのメソッドが既に宣言されており、それらの JavaDoc が "Work" に記述されているとします。「MyWork」に JavaDoc を追加する必要がありますか?

乾杯！

score 5 · Accepted Answer

場合によります。メソッドをオーバーライドしない場合、Javadoc を追加するオプションはありません (クラスレベルでのみ)。Javadoc が存在する理由を説明する Javadoc をクラスに追加することは理にかなっています。

メソッドをオーバーライドする場合は、次のように Javadoc を記述できます。

/**
 * {@inheritDoc}
 * This implementation also does...
 */

score 2 · Accepted Answer

2

非公開コードの場合、@inheritDoc処理できないものは気にしません。

于 2013-03-23T16:00:02.093 に答える

score 0 · Accepted Answer

MyWorkのメソッドがの機能をオーバーライドしない限り、メソッドはWorkスーパークラスと同様に動作すると想定しても問題ありません。オーバーライドされていないメソッドまたはフィールドを文書化する理由はありません。

score 0 · Accepted Answer

抽象メソッドについて話していると思いますので、「MyWork」クラスはそれらをオーバーライドする必要があります。

それらに特別な動作がない場合は、新しい JavaDoc を追加する必要はありません。それ以外の場合は、抽象メソッドの実装方法を文書化します。通常、このメソッドが抽象であり、継承クラスで実装する必要があり、抽象クラス自体には実装されていない理由が必要です。

{@inheritDoc}継承されたドキュメントのテキストを取得し、その下に特別な動作を追加するために使用できます。

4 に答える 4