Javadoc@see还是{@link}?
有人能告诉我javadocJavadoc@see还是{@link}?,java,javadoc,Java,Javadoc,有人能告诉我javadoc@see和{@link}之间的区别吗 或者更确切地说,什么时候使用哪种方法?关于这一点的说明非常清楚 功能上的区别是: {@link}是一个内联链接,可以放在任何你喜欢的地方 @请参见创建自己的部分 在我看来,{@link}最好是在描述中使用类、字段、构造函数或方法名。用户将能够点击到您链接的javadoc 我在两种情况下使用@see注释: 某些内容非常相关,但在描述中未提及 我在描述中多次提到同一事物,并将其用作指向同一事物的多个链接的替换 我的观点基于随机检
@see
和{@link}
之间的区别吗
或者更确切地说,什么时候使用哪种方法?关于这一点的说明非常清楚
功能上的区别是:
是一个内联链接,可以放在任何你喜欢的地方{@link}
创建自己的部分@请参见
{@link}
最好是在描述中使用类、字段、构造函数或方法名。用户将能够点击到您链接的javadoc
我在两种情况下使用@see
注释:
- 某些内容非常相关,但在描述中未提及
- 我在描述中多次提到同一事物,并将其用作指向同一事物的多个链接的替换
我的观点基于随机检查标准库中各种各样的文档。
@see
在Javadocs中创建了一个孤立的行<代码>{@link}用于嵌入文本
当它是一个相关实体时,我使用@see
,但在解释性文本中我没有提到它。我在文本中使用紧密耦合的链接,或者(我觉得)读者可能会从导航提示中受益,例如,您需要直接引用它。还有另一个引用(弃用部分)与{@link}
相比,更喜欢{@link}
。(自Java 1.2以来):
对于Javadoc1.2及更高版本,标准格式是使用@deprecated
标记和内联的{@link}标记。这将创建串联链接,其中
你想要它。例如:
对于Javadoc1.1,标准格式是创建一对@deprecated和@see标记。例如:
@see
标记与@link
标记有点不同,在某些方面受到限制,在其他方面更灵活: 不同的JavaDoc链接类型
- 可重构、可定制,并保留在中,另请参见部分
- 在Eclipse悬停中显示良好
- 显示链接标记及其生成时的格式javadoc确实警告说@link非常密集,应该仅在必要时使用。对于任何查看的人,您都可以在中获得有关此的详细信息(包括上面注释中关于
)的警告。另一种查看方式是,{@link}呈现为可单击的链接,@see只是一个文本部分@link