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

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

Ответ 1

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

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

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

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

Ответ 2

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

Ответ 3

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