Javadoc @see或{@link}？

Question

有人能告诉我javadoc @see和{@link}？之间的区别吗？

或者更确切地说,何时使用它们中的哪一个？

Answer 1

关于此的官方指南非常清楚.

功能差异是:

• {@link} 是一个内联链接,可以放在任何你喜欢的地方
• @see 创建自己的部分

在我看来,{@link}最好在你的描述中使用类,字段,构造函数或方法名称时使用.用户可以点击你链接的javadoc.

我@see在2种情况下使用注释:

• 某些内容非常相关,但在说明中未提及.
• 我在描述中多次引用相同的东西,它被用作替换相同的多个链接.

我基于随机检查标准库中各种各样的文档的文档.

Answer 2

@see在Javadocs中创建一个孤立的行.{@link}用于嵌入文本中.

我使用@see它是一个相关的实体,但我没有在说明文本中引用它.当紧密耦合时,我在文本中使用链接,或者(我觉得)读者可能会从导航提示中受益,例如,您需要直接引用它.

Answer 3

tag@see与 tag 有点不同@link，
在某些方面受到限制，而在其他方面则更灵活：

^{不同的 JavaDoc 链接类型}

1. 显示成员姓名以便更好的学习，并且可重构；通过重构重命名时名称将更新
2. 可重构和可定制；显示您的文字而不是会员姓名
3. 显示名称，可重构
4. 可重构、可定制
5. 一个相当平庸的组合是：

• 可重构、可定制，并保留在“另请参阅”部分中
• 在 Eclipse 悬停中显示良好
• 显示链接标签及其生成时的格式
• 使用多个@see项目时，描述中的逗号会使输出混乱

6. 完全非法；导致生成器中出现意外内容和非法字符错误

请参阅下面的结果：

^{不同链接类型的JavaDoc生成结果}

此致。

Answer 4

还有一个参考（折旧部分）同官方的文档喜欢{@link}过@see（自从Java 1.2）：

对于 Javadoc 1.2 及更高版本，标准格式是使用 @deprecated 标记和内联 {@link} 标记。这会在您想要的位置创建内嵌链接。例如：

对于 Javadoc 1.1，标准格式是创建一对 @deprecated 和 @see 标签。例如：