Класс тега Javadoc {@inheritDoc}
Я хотел бы использовать {@inheritDoc} класс для наследования методов от моего абстрактного класса. В документации для абстрактного класса я обращаюсь к абстрактному классу по имени. Как я могу отметить это поэтому, когда подкласс наследовал документацию от суперкласса, это заменяет имя абстрактного класса именем подкласса?
2 ответа
То, что вы описываете, не поддерживается инструментом генерации javadoc.
И я думаю, что для этого тоже есть веская причина :
Если ваш метод в подклассе является просто реализацией абстрактного метода, то я думаю, что было бы корректно оставить там имя абстрактного класса.
С другой стороны, если ваш метод в подклассе не является простой реализацией, а делает нечто большее, что заслуживает внимания (достаточно упомянуть в javadoc), то вам следует написать новый javadoc на метод в подклассе, вместо того, чтобы вызывать наследующийDoc.
for(var i = 0; i < restaurants.length; i++)
{
if(restaurants[i].restaurant.food == 'chicken')
{
return restaurants[i].restaurant.name;
}
}
Я не знаю о способе, но вы можете уточнить, почему вы хотите {@ inheritdoc} , чтобы сделать это. Я могу неправильно понять, но кажется запутанным. Вы можете документировать, как ваша бетонная реализация зависит от родителя и использовать @see для обозначения договора в абстрактном классе. ПРИМЕЧАНИЕ « Автоматическое копирование комментариев метода « может исчезнуть необходимость в явном {@ inheritdoc} .