时间戳

首页 > 解决方案 > JavaDoc 覆盖

java - JavaDoc 覆盖

问题描述

首先解决重复的可能性：

我不是在问 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-TT- 具有以下 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()

如何在 JavaDoc 中获取 Overrides 标记。当我输入@Overrides 时，它会按字面意思输入描述“@Overrides”。如何在 Comparator 类中显示 JavaDoc 标记Overrides: equals in class Object？

标签： javaoverridingjavadoc

解决方案

根据此技术说明（“方法注释的自动重用”部分，大约三分之一的内容），如果方法覆盖另一个方法，JavaDoc 工具会自动生成“覆盖”部分。

从上述链接：

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

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

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

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

推荐阅读