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

JavaDoc中@see的用法?

那绪
2023-03-14
问题内容

什么时候使用@see与JavaDoc中处理时?它的用途是什么?

例如,如果MethodA呼叫MethodB然后做我必须把@seeMethodBjavadoc和引用MethodA,因为这就是所谓呢,还是我已经把一个引用MethodBMethodA,因为它调用它。我已经阅读了@seeOracle网站上的内容,在我看来似乎非常模糊,它表示“请参见”,但实际上并不意味着!


问题答案:

是的,这很模糊。

每当对方法文档的读者来说,都应该使用它,同时查看其他方法可能会很有用。如果您的methodA文档说“像methodB一样工作,但是…”,那么您当然应该放置一个链接。@see内联{@link ...}标签的替代方法是:

/**
 * ...
 * Works like {@link #methodB}, but ...
 */

当methodA调用methodB的事实是一个实现细节,并且与外界没有真正的联系时,您无需在此处链接。



 类似资料:
  • 问题内容: 有人可以告诉我javadoc 和之间的区别吗? 或更确切地说,什么时候使用它们? 问题答案: 该官方指南上这是很清楚的。 功能上的差异是: 是一个内联链接,可以放置在您喜欢的任何位置 创建自己的部分 我认为,最好在描述中使用字面意义上的类,字段,构造函数或方法名称。用户将能够单击您所链接内容的javadoc。 我在2种情况下使用注释: 某些内容非常相关,但说明中未提及。 我在描述中多次

  • 问题内容: 如何正确使用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 是事件驱动,基于插件的沙箱

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

  • Textualize See是一个命令行工具,用于在终端打开文件。该项目暂时处于 alpha 版本,目前只在 MacOS 下进行了测试,但它旨在面向所有平台工作。 一个 TOML 配置文件将 glob-style 模式映射到命令上。例如,你可以配置 See 来打开任何符合 "*.py "模式的文件,用Rich-cli来打开 "*.rs "文件,用bat来打开。 把 see 想象成是终端上的双击桌面