JavaDoc覆盖

JavaDoc覆盖,java,overriding,javadoc,Java,Overriding,Javadoc,首先要解决重复的可能性: 我不是问什么是Override,它是什么意思,也不是问java文档注释之外的@Override。那是我不是问 /**Some JavaDoc Comment*/ @override public void methodA(){} 这意味着什么。希望我强调得不够好我也不是问何时使用@Override或什么是javadoc或如何做java doc评论。(是的,我强调了很多,但我宁愿详细说明问题,也不愿无缘无故地被标记为重复问题) 现在谈问题: 在java文档中,compa

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

我不是问什么是Override,它是什么意思,也不是问java文档注释之外的@Override。那是我不是问

/**Some JavaDoc Comment*/
@override
public void methodA(){}
这意味着什么。希望我强调得不够好我也不是问何时使用@Override或什么是javadoc或如何做java doc评论。(是的,我强调了很多,但我宁愿详细说明问题,也不愿无缘无故地被标记为重复问题)

现在谈问题:

在java文档中,comparator类: 具有以下方法说明:

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标记显示
覆盖:类对象中的equals

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

从上述链接:

通过了解Javadoc工具如何为重写或实现其他方法的方法复制(继承)注释,可以避免重新键入doc注释。这种情况发生在三种情况下:

类中的方法重写超类中的方法时 当接口中的方法重写超级接口中的方法时 类中的方法在接口中实现方法时 在前两种情况下,如果一个方法m()重写了另一个方法,Javadoc工具将在m()的文档中生成一个副标题“overrides”,并带有指向它重写的方法的链接

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

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

基于此(大约三分之一的“自动重用方法注释”部分),如果一个方法重写了另一个方法,“重写”部分将由JavaDoc工具自动生成

从上述链接:

通过了解Javadoc工具如何为重写或实现其他方法的方法复制(继承)注释,可以避免重新键入doc注释。这种情况发生在三种情况下:

类中的方法重写超类中的方法时 当接口中的方法重写超级接口中的方法时 类中的方法在接口中实现方法时 在前两种情况下,如果一个方法m()重写了另一个方法,Javadoc工具将在m()的文档中生成一个副标题“overrides”,并带有指向它重写的方法的链接

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

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


它不是仅仅因为该方法重写了另一个方法而出现吗?@AndyTurner它不是。至少对我来说是在Eclipse上。@AndyTurner和no如果我添加任何自己的文档,它不会出现,因此我需要指定该文本,以及问题的方式。这实际上与
@覆盖
注释没有任何关系。无论如何,“覆盖:”应该出现在生成的javadoc中。我从未生成过不自动添加的javadoc。@VGR您使用的IDE是什么?如果是eclipse,它是否会出现在工具提示上(当您在方法上高亮显示并显示java文档等价物时)?它出现的原因是否仅仅是该方法重写了另一个方法?@AndyTurner它没有。至少对我来说是在Eclipse上。@AndyTurner和no如果我添加任何自己的文档,它不会出现,因此我需要指定该文本,以及问题的方式。这实际上与
@覆盖
注释没有任何关系。无论如何,“覆盖:”应该出现在生成的javadoc中。我从未生成过不自动添加的javadoc。@VGR您使用的IDE是什么?如果是eclipse,它是否会出现在工具提示上(当您突出显示方法并显示java文档等价物时)?我知道这一点。我确实需要向重写的方法添加文档注释,@Overrides副标题和链接仍然出现,但正如它所说的那样(不会复制任何文本),因此我想自己编写该文本。我知道这一点。我确实需要向重写的方法添加文档注释,@Overrides副标题和链接仍然出现,但正如它所说的那样(不会复制任何文本),因此我想自己编写该文本。