web-dev-qa-db-ja.com

Javadoc {@inheritDoc}タグクラス

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

42
LandonSchropp

説明している内容は、javadoc生成ツールではサポートされていません。

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

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

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

45
bguiz

方法はわかりませんが、なぜあなたが望むのかを詳しく説明するかもしれません {@inheritDoc} これを行うには。私は誤解するかもしれませんが、混乱しているようです。具体的な実装が親からどのように変化するかを文書化し、 @see は、抽象クラスのコントラクトを参照します。注 "メソッドコメントの自動コピー" は、明示的な {@inheritDoc}

16
trashgod

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

0
Ti Strga