java - Javadoc {@inheritDoc} タグ クラス

Question

{@inheritDoc}このクラスを使用して、抽象クラスからメソッドを継承したいと考えています。抽象クラスのドキュメントでは、抽象クラスを名前で参照しています。サブクラスがスーパークラスからドキュメントを継承するときに、抽象クラスの名前をサブクラスの名前に置き換えるにはどうすればよいですか?

Answer 1

あなたが説明していることは、javadoc 生成ツールではサポートされていません。

そして、これには正当な理由もあると思います。

サブクラスのメソッドが単に抽象メソッドの実装である場合は、そこに抽象クラスの名前を残すのが正しいと思います。

反対に、サブクラスのメソッドが単純な実装ではなく、注目に値する何かを実行する場合 (javadoc で言及するのに十分です)、代わりに、サブクラスのメソッドに新しい javadoc を記述する必要があります。 inheritDoc の呼び出し。

Answer 2

私は方法を知りませんが、なぜあなたがこれをしたいのかについて詳しく説明するかもしれません{@inheritDoc}。誤解するかもしれませんが、紛らわしいようです。具体的な実装が親からどのように変化するかを文書@see化し、抽象クラスのコントラクトを参照するために使用できます。「メソッドコメントの自動コピー」により、明示的なの必要がなくなる場合があることに注意してください{@inheritDoc}。

Answer 3

IIRCは、{@inheritDoc}自分のコメントでタグの周りに追加のテキストを書くこともできます。