首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

在Javadoc中使用@link和@see

是为了在文档中创建链接,以便于查看相关的类、方法或者其他文档。

@link标签用于创建一个链接到指定的类、方法或者其他文档。它可以用于在文档中引用其他类或者方法的名称,并且可以通过点击链接直接跳转到相关的文档。使用@link标签时,需要在标签后面紧跟着要链接的类或者方法的全名,包括包名和类名或者方法名。

例如,假设我们有一个名为"com.example.MyClass"的类,我们可以在Javadoc中使用@link标签来引用它:

{@code

/**

  • This is a sample class that demonstrates the usage of the {@link com.example.MyClass}. */ public class AnotherClass { // ... } }

在上面的例子中,{@link com.example.MyClass}会创建一个链接到"com.example.MyClass"类的文档。

@see标签用于创建一个链接到其他相关的文档。它可以用于引用其他类、方法或者其他文档,以提供更多的相关信息。与@link标签不同的是,@see标签可以引用其他文档的简单名称,而不需要包括完整的包名和类名。

例如,假设我们有一个名为"com.example.MyClass"的类,我们可以在Javadoc中使用@see标签来引用它:

{@code

/**

  • This is a sample class that demonstrates the usage of the {@see MyClass}. */ public class AnotherClass { // ... } }

在上面的例子中,{@see MyClass}会创建一个链接到"com.example.MyClass"类的文档。

总结起来,@link和@see标签都是用于在Javadoc中创建链接的标签。@link标签用于引用其他类或者方法的全名,而@see标签用于引用其他文档的简单名称。这些标签可以提供更多的相关信息,方便开发者在阅读文档时快速查找和跳转到相关的内容。

腾讯云相关产品和产品介绍链接地址:

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

【说站】csslink@import的区别

csslink@import的区别 1、从属关系区别 @import是 CSS 提供的语法规则,只有导入样式表的作用; link是HTML提供的标签,不仅可以加载 CSS 文件,还可以定义 RSS...2、加载顺序区别 加载页面时,link标签引入的CSS被同时加载;@import引入的CSS将在页面加载完毕后被加载。...3、兼容性区别 @import是 CSS2.1 才有的语法,故只可在 IE5+才能识别; link标签作为 HTML 元素,不存在兼容性问题。...4、DOM可控性区别 可以通过JS操作DOM ,插入link标签来改变样式;由于DOM方法是基于文档的,无法使用@import的方式插入样式。...5、权重区别,link引入的样式权重大于@import引入的样式。 以上就是csslink@import的区别,希望对大家有所帮助。

31820

Javadoc 使用详解

写了Javadoc别人使用到类时,将鼠标悬停到类上或者方法上,javadoc会以提示信息显示出来,这样开发者跳进源代码中就能知道类或者方法的作用。...@link:{@link 包名.类名#方法名(参数类型)} 用于快速链接到相关代码 @link使用语法{@link 包名.类名#方法名(参数类型)},其中当包名在当前类已经导入了包名可以省略,可以只是一个类名...等不会被解释成html标签, code标签有自己的样式 一般Javadoc只要涉及到类名或者方法名,都需要使用@code进行标记。...一般p经常结合pre使用,或者pre结合@code共同使用(推荐@code方式) 一般经常使用pre来举例如何使用方法 注意:pre>标签如果有小于号、大于号、例如泛型 在生产javadoc时会报错...@inheritDoc @inheritDoc用于注解重写方法或者子类上,用于继承父类Javadoc 基类的文档注释被继承到了子类 子类可以再加入自己的注释(特殊化扩展) @return @param

95920

IDEA如何使用javadoc工具导出API 文档注解@Documented的具体作用

的 -locale 参数,如果不填,默认可能是英文或者是当前操作系统的语言,既然是国人,建议在此填写 zh_CN,这样生成的 JavaDoc 就是中文版本的,当然指的是 JavaDoc 的框架各种通用的固定显示区域都是中文的...这里必须要填写如下参数: -encoding UTF-8 -charset UTF-8 -windowtitle "你的文档浏览器窗口标题栏显示的内容" -link http://docs.oracle.com...IDEA简单使用javadoc工具教程就到这里了。...2、@Documente 2.1 未使用@Documented注解 2.2 使用了@Documented注解  所以总结就是:自定义注解的时候可以使用@Documented来进行标注,如果使用...3、总结 3.1 IDEA使用javadoc工具步骤: Tools->Generate JavaDoc->配置好相关事项 3.2  如果使用@Documented标注了,在生成javadoc的时候就会把

1.2K20

PHP,cookiesession的使用

用途:PHP的Cookie具有非常广泛的使用,经常用来存储用户的登录信息,购物车等,且使用会话Session时通常使用Cookie来存储会话id来识别用户,Cookie具备有效期,当有效期结束之后,...一般情况下,大多是使用所有路径的,只有极少数有特殊需求的时候,会设置路径,这种情况下只指定的路径才会传递cookie值,可以节省数据的传输,增强安全性以及提高性能。...使用session PHP中使用session非常简单,先执行session_start方法开启session,然后通过全局变量$_SESSION进行session的读写。...用户登录成功以后,通常可以将用户的信息存储session,一般的会单独的将一些重要的字段单独存储,然后所有的用户信息独立存储。...$_SESSION['uid'] = $userinfo['uid']; $_SESSION['userinfo'] = $userinfo; 一般来说,登录信息既可以存储sessioin,也可以存储

4K70

GitGitHub如何使用分支

之前关于 git 版本控制软件的两篇教程,我们学习了 使用 git 的基本命令,以及 如何使用 GitHub 来建立仓库并将我们的项目代码推送到网站。...像 GitHub、GitLab BitBucket 这样的平台通过云端托管 git 仓库,使使用 git(尤其是团队项目中)更加用户友好,开发人员可以云端存储、共享与他人协作编写代码。...(本教程,我们使用 GitHub,但其他基于 git 的版本控制平台的工作方式相同)。 什么是 Git 分支?...我们的场景,我们将使用 hello_octo 分支来进行测试我们的更改,然后将这些更改推送到 GitHub 上的主分支。...到目前为止,我们一直使用一个极其简化的示例项目,因为此时最重要的是理解吸收 git 工作流程。现实世界,合并比这要复杂得多 - 例如,如果您的合并出现冲突,会发生什么?

3610

WordPress 如何使用 Date Time

使用 Date Time 是程序员一个非常日常的工作,比如定时发布,定时抓取信息等。...PHP 提供很多 date/time 函数,但是 WordPress 有自己的一套,下面讲解下 WordPress 中使用 Date Time 的经验坑。...时区 - Timezone 使用 date/time 第一个的要注意的时时区,很多错误都是因为这个引起的,比如定时发布的文章错误的时间发布了(比如你想是北京时间明天早上8点发布的,但是发布格林尼治时间早上...Date time 格式 WordPress 让我们 设置 > 常规 修改默认的时间格式,所以我们尽量代码使用这个格式,而不要使用 date() 来生成,除非你自己要生成特殊的格式。...PHP 可以使用 Date Time 做很多事情,但是一定要用 WordPress 方式使用它们。

1.4K10

Dart 更好地使用 mixin

但是 Dart 并不要求所有代码都定义一个类。我们可以一个类的外面定义顶级变量、常量、函数 —— 就像面向过程语言那样。正式因为这样,Dart 的编码会有些特殊的建议。...但是, Dart ,如果仅仅是一个函数,定义类反而使得代码不好维护。这个时候建议直接使用 typedef 来定义函数别名。...maxLength = 256; public static int minLength = 5; } 复制代码 这样做的好处是假设静态常量名多个类定义的话,可以通过命名空间避免冲突。...这个很多语言都有介绍过,继承应该仅在子类符合“is a”父类的关系的时候才使用。...建议4:不要使用 implements 实现非接口类 接口类的定义的好处是可以多种实现方式中切换而无需更改代码,依赖注入型的框架或代码结构中会经常使用面向接口编程的方式。

2.4K00

页面导入样式时,使用link@import有什么区别?

link@import有什么区别 区别1:link是XHTML标签,除了加载CSS外,还可以定义RSS等其他事务;@import属于CSS范畴,只能加载CSS。...区别2:link引用CSS时,页面载入时同时加载;@import需要页面网页完全载入以后加载。...区别4:link支持使用Javascript控制DOM去改变样式;而@import不支持。html设计制作,css有四种引入方式。...因为 CSS 代码是 HTML 文件,所以会使得代码比较集中,当我们写模板网页时这通常比较有利。因为查看模板代码的人可以一目了然地查看 HTML 结构 CSS 样式。...*{ margin:0; padding:0;} .notice-link a{ color:#999;} 比较链接方式导入方式 链接方式(下面用 link 代替)导入方式(下面用 @import

4K20

DOC文档注释,让你的代码如此清晰。

Javadoc command:执行doc文档注释的命令,也可以cmd窗口中输入这个命令 Select types for which Javadoc will be generated:要生成文档注释的项目...3.doc注释 3.1多行注释 对于属性,方法,类的注释必须使用多行注释,单行注释不会生成到文档 3.2属性注释: /** 员工ID */ private String workerId; 3.3方法注释...>> queryAgentDKList(String workerId, Integer topNum); 这里多使用注解就能生成漂亮的文档了,参数返回对象一定要写清楚,如果有对象参数的话,就可以用@...workerId, PageInfo page); 这里的@see@link都可以链接到指定对象的注释文档页面,具体区别使用一次之后就一目了然了,同时@see@link后面的对象也是需要导包的,不导包的话就使用全局限定名...,如@see java.util.List 当然,还可以加入自己定义的一些注解,这些注解要生成到文档注释中就要在如上图的2.3步骤声明出来,如@功能描述 3.4类的注释 /** * @功能描述: 接口返回错误码

1.5K40

阿里Java编程规约【三】代码格式

{@link reference } {@link}标签 @see标签的作用类似,但 @see 标签是专门的“See Also:”区域放一个指向引用的链接,而 {@link}标签在行内插入链接。...文档注释,只要能使用 HTML 文本的地方都可以使用{@link} 标签。 例如: @param regexp 搜索时使用的正则表达式。...{@linkplain reference } {@linkplain}标签 {@link} 标签的作用类似,不过, {@linkplain} 标签生成的链接,链接文字使用普通的字体,而 {@link...package.html 文件可以包含简单的 HTML 格式文档,也可以使用 @see、@link、@deprecated @since 标签。...最后, package.html 文件,所有 @see @link 标签都必须使用完全限定的类名。

88410

如何使用esgrafanatempo查找trace

Tempo的工作是存储大量跟踪,将其放置在对象存储,并通过ID检索它们。日志其他数据源使用户能够比以往更快,更强大地直接跳转到跟踪。 以前,我们使用Loki示例程序[1]研究了发现traces。...本文中,我们探索使用另一个日志记录替代方案ElasticsearchGrafana来直接建立从日志到traces的链接。...Elasticsearch数据链接 设置从Elasticsearch到Tempo的链接的技巧是使用data-linkElasticsearch数据源配置,它类似于以下内容: ?...正确设置此链接后,然后Explore,我们可以直接从日志跳转到trace: ? 现在,您还可以使用Elasticsearch日志记录后端的所有功能来查找trace!...在过去的文章,我们研究了使用Loki示例,但我们也知道Elasticsearch是一个极其常见的日志记录后端。

4K20
领券