问Javadoc @see还是{@link}？

EN

关于这一点的official guidelines非常清楚。

功能上的区别是：

• {@link}是一个内联链接，可放置在like
• @see创建其自己的

部分的任何位置

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

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

description.

• I中未提及的相关内容
• 在说明中多次引用同一内容，并用作指向同一内容的多个链接的替代。

我的这个观点是基于随机检查标准库中各种内容的文档。

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

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

还有另一个参考(弃用部分)相同的official docs，更喜欢{@link}而不是@see (从Java1.2开始)：

对于Javadoc 1.2和更高版本，标准格式是使用@

和内嵌的{@link}标记。这将在您想要的位置创建内联链接。例如：

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