当前位置: 首页 > 知识库问答 >
问题:

@see和@inheritDoc之间的区别细节

钱焕
2023-03-14

我已经查看了JavaDoc参考,虽然我了解@see(各种链接)和{@inheritDoc}(导出超类JavaDoc注释)之间的基本区别,但我需要澄清事情是如何实际实现的。

在EclipseIDE中,当我为继承的方法选择“GenerateElementComments”(从接口或toString()重写等)时,它会创建以下注释

/* (non-Javadoc)
 * @see SomeClass#someMethod()
 */

如果我被要求生成JavaDoc,如果我不这样做,请将@see替换为{@inheritDoc},或者将其转换为真正的JavaDoc:

/**
 * {@inheritDoc}
 */

当我这样做的时候,我还应该保留类#方法标志吗?

共有1个答案

程俊力
2023-03-14

首先,您应该删除原始的 eclipse 模板,因为它只是嘈杂的垃圾。要么放有意义的文档,要么根本不放任何东西。但是,使用 IDE 模板重述显而易见的内容毫无用处只会使代码混乱。

其次,如果需要生成javadoc,则必须以/**开头注释。否则,它不是javadoc。

最后,如果您正在覆盖,那么您应该使用@in福尼亚Doc(假设您想添加到原始文档中,正如@seh在评论中指出的那样,如果您只想复制原始文档,那么您不需要任何东西)。@view应该只用于引用其他相关方法。

 类似资料:
  • 本文向大家介绍分页和细分之间的区别,包括了分页和细分之间的区别的使用技巧和注意事项,需要的朋友参考一下 分页 分页是一种内存管理技术,其中,进程地址空间被分成大小相同的块,称为页面(大小为2的幂,介于512字节和8192字节之间)。进程的大小以页数为单位。类似地,将主存储器划分为称为帧的(物理)存储器的固定小块,并且将帧的大小与页面的大小保持相同,以最佳利用主存储器并避免外部碎片。 类似地,将主存

  • 本文向大家介绍需求分页和细分之间的区别,包括了需求分页和细分之间的区别的使用技巧和注意事项,需要的朋友参考一下 内存管理是必不可少的功能之一,它可以为执行过程分配内存,并在不再需要该进程时取消分配内存。为此,基本上有两种方法-需求分页和分段。两者之间的差异定义如下。 以下是需求分页和细分之间的重要区别- 序号 键 需求分页 分割 1 定义 分页是一种内存管理技术,其中,进程地址空间分为大小相同的块

  • 问题内容: 我错放了太多次了,我想我一直忘记,因为我不知道两者之间的区别,只是一个给了我我期望的价值,而另一个却没有。 为什么是这样? 问题答案: 是的简写形式(尽管请注意,该表达式只会被计算一次。) 是的,即指定一元的到。 例子:

  • 问题内容: 因此,我有一段简单的代码可以打印出整数1-10: 然后,如果仅在第3行上更改一个运算符,它将打印出无限数量的1整数(我知道为什么会这样做)。为什么在运行第二个程序时没有出现语法错误?如果赋值运算符后面跟着一个加法运算符,它不会调用语法错误吗? 问题答案: 与相同, 只是意味着。

  • 问题内容: 有人可以解释一下 和 我不知道“确切”的含义 问题答案: 在这个例子中,什么都没有。当您具有多个具有相似名称的路径时,该参数将起作用: 例如,假设我们有一个显示用户列表的组件。我们还有一个用于创建用户的组件。的网址应嵌套在下。因此,我们的设置可能如下所示: 现在,这里的问题是,当我们转到路由器时,将通过所有定义的路由,并返回它找到的第一个匹配项。因此,在这种情况下,它将首先找到路线,然