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