小编典典

Javadoc @see 还是 {@link}?

all

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

或者更确切地说,什么时候使用它们中的哪一个?


阅读 65

收藏
2022-07-02

共1个答案

小编典典

这方面的官方指南非常明确。

功能上的区别是:

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

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

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

  • 有些东西非常相关,但在描述中没有提到。
  • 我在描述中多次提到相同的东西,它被用作多个链接的替代品。

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

2022-07-02