Javadoc @see或{@link}？

Question

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

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

Answer 1

official guidelines对此很清楚。

功能差异是：

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

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

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

• 某些内容非常相关，但未在说明中提及。
• 我在描述中多次引用相同的内容，并将其用作替换相同内容的多个链接。

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

Answer 2

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

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

Answer 3

@see 标签与 @link 标签略有不同，
在某些方面受到限制，在其他方面更加灵活：

^{不同的 JavaDoc 链接类型}

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

• 可重构、可定制，并留在另见部分
• 在 Eclipse 悬停中很好地显示
• 在生成时显示链接标签及其格式?
• 当使用多个 @see 项时，说明中的逗号会使输出变得混乱

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

查看以下结果：

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

最好的问候。

Answer 4

还有另外一个引用（弃用部分），与{@link}相比，official docs更喜欢@see（自Java 1.2起）：

  

对于Javadoc 1.2和更高版本，标准格式是使用@deprecated   标签和嵌入​​式{@link}标签。这将在线创建链接，其中   你想要它。例如：

     

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