当前位置: 首页 > 面试题库 >

Javadoc @see或{@link}?

蒯安平
2023-03-14
问题内容

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

或更确切地说,什么时候使用它们?


问题答案:

该官方指南上这是很清楚的。

功能上的差异是:

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

我认为,{@link}最好在描述中使用字面意义上的类,字段,构造函数或方法名称。用户将能够单击您所链接内容的javadoc。

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

  • 某些内容非常相关,但说明中未提及。
  • 我在描述中多次提到相同的事物,它被用来替代指向同一事物的多个链接。

我基于随机签出文档中标准库中各种各样内容的观点。



 类似资料:
  • 问题内容: 什么时候使用与JavaDoc中处理时?它的用途是什么? 例如,如果呼叫然后做我必须把中的javadoc和引用,因为这就是所谓呢,还是我已经把一个引用从,因为它调用它。我已经阅读了Oracle网站上的内容,在我看来似乎非常模糊,它表示“请参见”,但实际上并不意味着! 问题答案: 是的,这很模糊。 每当对方法文档的读者来说,都应该使用它,同时查看其他方法可能会很有用。如果您的methodA

  • 问题内容: 如何正确使用Javadoc? 我的意图是拥有一个带有抽象方法的抽象类。这些方法具有javadoc注释。现在,如果我扩展了抽象类,则将覆盖这些方法并要使用。 但对于所有的参数,可以如用于该链接似乎没有工作时。Eclipse仍然抱怨。 那么我该如何使用呢? 问题答案: 为了包括超类的文档,您不应使用not 。 然后,您将获得超类的文档。您可以添加它,并且可以覆盖诸如和所需的东西。

  • 说明: 更多详细信息请参阅其他一些文档。 语法 @see <namepath> @see <text> 概述 @see标签表示可以参考另一个标识符的说明文档,或者一个外部资源。您可以提供一个标识符的namepath或自由格式的文本。如果你提供了一个namepath,JSDoc的默认模板会自动将namepath转换成链接。 例子 例如,使用@see标签: /** * Both of these w

  • SEE

    Sandboxed Execution Environment (SEE) 是在安全环境构建自动化测试的框架。 通过 libvirt 提供可定制的,灵活度高的沙箱。测试环境可以运行不同类型的虚拟机监控程序 (Qemu, VirtualBox, LXC) 。 测试环境可以添加插件,提供一个 Event 机制同步交互,用户通过一个 JSON 配置文件启用和配置插件。 SEE 是事件驱动,基于插件的沙箱

  • 我在让“@link”和“@see”标记为内部/嵌套类的构造函数工作时遇到问题,希望这里的人能提供帮助。这个简短的示例类在第25行给出了javadoc警告,其中引用了“Layer()”文档前面几行中的“@link”和(等效的)“@see”标记。 警告(3个表示“@see”,3个表示“@link”)都说:。 请注意:所有其他javadoc都按预期工作(包括内部类方法和我在本例中对LayeredPlot

  • See-saw是一个可用于创建桌面应用程序的库。 要使用See-saw,首先从以下github链接下载.clj文件https://github.com/daveray/seesaw 然后创建一个示例桌面应用程序 以下是相同的代码。 (ns web.core (:gen-class) (:require [seesaw.core :as seesaw])) (def window (se