JavaDoc覆盖

问题描述 投票:0回答:1

首先要解决重复的可能性:

我不是在询问Override是什么,它意味着什么,或者在java doc注释之外的@Override。那是我不问

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

这意味着什么。希望我强调不够好。我也不是在问什么时候使用@Override或什么是javadoc或者如何做java doc注释。 (是的,我强调了很多,但我宁愿指出问题而不是无缘无故地将其标记为重复)。

现在问题:

在java文档中,比较器类:https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html#compare-T-T-具有以下等于方法描述:

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()

如何在JavaDoc中获取Overrides标记。当我放入@Overrides时,它在字面上输入了描述“@Overrides”。如何在Comparator类中获取该JavaDoc标记以显示Overrides: equals in class Object

java override javadoc
1个回答
1
投票

基于此tech note(“自动重用方法注释”一节,大约三分之一),如果方法覆盖另一个方法,则“覆盖”部分由JavaDoc工具自动生成。

从上述链接:

您可以通过了解Javadoc工具如何复制(继承)覆盖或实现其他方法的方法的注释来避免重新键入文档注释。这种情况发生在三种情况:

当类中的方法重写超类中的方法时当接口中的方法覆盖超接口中的方法时类中的方法在接口中实现方法在前两种情况下,如果方法m()覆盖另一个方法方法,Javadoc工具将在m()的文档中生成一个子标题“Overrides”,其中包含指向它所覆盖的方法的链接。

在第三种情况下,如果给定类中的方法m()在接口中实现方法,则Javadoc工具将在m()的文档中生成子标题“Specified by”,并带有指向它正在实现的方法的链接。

在所有这三种情况下,如果方法m()不包含文档注释或标记,则Javadoc工具还将复制它覆盖或实现的方法文本到m()的生成文档。因此,如果重写或实现的方法的文档已足够,则无需为m()添加文档。如果向m()添加任何文档注释或标记,则仍会显示“覆盖”或“指定者”子标题和链接,但不会复制任何文本。

© www.soinside.com 2019 - 2024. All rights reserved.