Переопределение JavaDoc

Question

Сначала рассмотрим возможность дублирования:

Я не спрашиваю, что такое Override, что это значит или @Override вне комментария java doc . То есть Я не спрашиваю

/**Some JavaDoc Comment*/
@override
public void methodA(){}

что это значит. Надеюсь, я подчеркнул недостаточно хорошо. Я также не спрашиваю , когда использовать @Override или , что такое javadoc или , как делать комментарии Java-документа. (Да, я много подчеркнул, но я бы предпочел переопределить вопрос, а не помечать его как дубликат без причины).

Теперь к вопросу:

В документации Java, класс компаратора: https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html#compare-T-T- имеет следующее описание метода equals:

Overrides:
equals in class Object
Parameters:
obj - the reference object with which to compare.
Returns:
true only if the specified object is also a comparator and it imposes the same ordering as this comparator.
See Also:
Object.equals(Object), Object.hashCode()

Как получить тег Overrides в JavaDoc. Когда я ставлю @Overrides, он буквально печатает в описании "@Overrides". Как получить, чтобы тег JavaDoc, как в классе Comparator, отображал Overrides: equals in class Object?

Answer 1

На основе этой технической заметки (раздел «Автоматическое повторное использование комментариев метода», примерно на треть пути вниз) раздел «Переопределения» автоматически создается инструментом JavaDoc, если метод переопределяет другой метод.

Из вышеупомянутой ссылки:

Вы можете избежать повторного ввода комментариев к документам, зная, как инструмент Javadoc дублирует (наследует) комментарии для методов, которые переопределяют или реализуют другие методы. Это происходит в трех случаях:

Когда метод в классе переопределяет метод в суперклассе Когда метод в интерфейсе переопределяет метод в суперинтерфейсе Когда метод в классе реализует метод в интерфейсе В первых двух случаях, если метод m () переопределяет другой метод, инструмент Javadoc сгенерирует подзаголовок «Переопределения» в документации для m () со ссылкой на метод, который он переопределяет.

В третьем случае, если метод m () в данном классе реализует метод в интерфейсе, инструмент Javadoc сгенерирует подзаголовок «Определено» в документации для m () со ссылкой на метод это реализует.

Во всех трех из этих случаев, если метод m () не содержит комментариев или тегов документа, инструмент Javadoc также скопирует текст метода, который он переопределяет или реализует, в сгенерированную документацию для m (). Таким образом, если документации переопределенного или реализованного метода достаточно, вам не нужно добавлять документацию для m (). Если вы добавите какой-либо комментарий к документации или тег в m (), подзаголовок и ссылка «Overrides» или «Specified by» по-прежнему будут отображаться, но текст не будет скопирован.