Javadoc @see或{@link}？

Question

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

或者说，什么时候使用它们？

Answer 1

对此的official guidelines很清楚。

功能上的差异是：

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

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

我使用@see注释2例：

• 东西是非常相关的，但在描述中没有提到。
• 我在描述中多次引用同一个东西，并且它被用作替代多个相同的链接。

我基于这种观点随机检出标准库中各种各样的文档。

Answer 2

@see在Javadocs中创建一条隔离线。 {@link}用于嵌入文本。

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