Класс тегов Javadoc {@inheritDoc}

Question

Я хотел бы использовать класс {@inheritDoc} для наследования методов от моего абстрактного класса. В документации по абстрактному классу я ссылаюсь на абстрактный класс по имени. Как я могу пометить это так, когда подкласс наследует документацию от суперкласса, он заменяет имя абстрактного класса на имя подкласса?

Answer 1

То, что вы описываете, не поддерживается инструментом генерации javadoc.

И я думаю, что для этого есть веская причина :

Если ваш метод в подклассе является просто реализацией абстрактного метода, то я думаю, что было бы правильно оставить там имя абстрактного класса.

С другой стороны, если ваш метод в подклассе не просто реализация и делает что-то более примечательное (достаточно упомянуть в javadoc), тогда вы должны написать новый javadoc для метода подкласс, вместо того, чтобы вызывать наследовать.

Answer 2

Я не знаю способа, но вы могли бы уточнить, почему вы хотите, чтобы {@inheritDoc} сделал это.Я могу неправильно понять, но это сбивает с толку.Вы можете задокументировать, как ваша конкретная реализация варьируется от родительского и использовать @see для ссылки на контракт в абстрактном классе.Примечание " Автоматическое копирование комментариев метода " может устранить необходимость в явном {@inheritDoc}.

Answer 3

Вы также можете, IIRC, написать дополнительный текст вокруг тега {@inheritDoc} в своих комментариях.