Javadoc @see或{@link}?
有人能告诉我javadoc @see
和{@link}
之间的区别吗?
或者说,什么时候使用哪一个呢?
关于这方面的官方指引非常明确。
function差异是:
-
{@link}
是一个内联链接,可以放在任何你喜欢的地方 -
@see
创build自己的部分
在我看来, {@link}
最好在你的描述中使用类,字段,构造函数或方法名时使用。 用户将能够点击到你已经链接的javadoc。
在两种情况下,我使用@see
注释:
- 有些东西是非常相关的,但在描述中没有提及。
- 我在描述中多次提到相同的东西,并且它被用作替代多个相同的链接。
我基于这个意见随机检查了标准库中的各种各样的文档。
@see
在Javadocs中创build一个单独的行。 {@link}
用于在文本中embedded。
我使用@see
时它是一个相关的实体,但我没有在说明文本中引用它。 当耦合紧密时,我使用文本中的链接,或者(我觉得)读者可能从导航提示中受益,例如,您需要直接引用它。