Класс тегов Javadoc {@inheritDoc}
Я хотел бы использовать {@inheritDoc} класс для наследования методов из моего абстрактного класса. В документации для абстрактного класса я ссылаюсь на абстрактный класс по имени. Как я могу пометить это так, когда подкласс наследует документацию от суперкласса, он заменяет имя абстрактного класса именем подкласса?
3 ответов
то, что вы описываете, не поддерживается инструментом генерации javadoc.
и я думаю, что есть причина для этого:
Если ваш метод в подклассе является просто реализацией абстрактного метода, то я думаю, что было бы правильно оставить там имя абстрактного класса.
с другой стороны, если ваш метод в подклассе не просто простая реализация, а делает что-то еще, что заслуживает внимания (достаточно упомянуть в javadoc), тогда вы должны написать новый javadoc в методе в подклассе, вместо вызова inheritDoc.
Я не знаю способа, но вы можете уточнить, почему вы хотите {@inheritDoc} для этого. Я могу неправильно понять, но это кажется запутанным. Вы можете документировать, как ваша конкретная реализация варьируется от родителя и использовать @see для ссылки на контракт в абстрактном классе. Примечание "автоматическое копирование комментариев метода" может устранить необходимость явного {@inheritDoc}.
вы также можете, IIRC, написать дополнительный текст вокруг {@inheritDoc} тег в ваших собственных комментариях.