Java Doc--{@link} 和 @see 使用

Java Doc – {@link} 和 @see 使用

一、 简介

在写 Java 代码时,我们可以写代码跳转的注释,我们可以通过【command+鼠标左键】实现跳转,常用的有 {@link} 和 @see。


二、 {@link}

{@link} 前面带有注释仍然可以跳转。

1. 跳转到类、方法、字段
/**
*  xxx
*  xxx {@link  [package.]<class>#[method||field]}
*/

主要用法如上,完整路径为【包名.类名#方法名或者字段名】

  • 跳转到类 {@link [package.] 类名} ,在同一路径下,包名应该可以省略
  • 如果是跳转当前类可以省略包名和类名,直接使用 {@link #[method||field]} 即可
2. 跳转到网址
/**
*  xxx 路径一定要带 http 或者 https 
*  xxx {@link <a href="http://www.xxx.com">这是一个网址</a>}
*/

三、 @see

@see 前面不可以带有注释, 否则不能跳转

1. 跳转到类、方法、字段
/**
*  xxx
*  @see  [package.]<class>#[method||field]
*/

主要用法如上,完整路径为【包名.类名#方法名或者字段名】

  • 跳转到类 @see [package.] 类名 ,在同一路径下,包名应该可以省略
  • 如果是跳转当前类可以省略包名和类名,直接使用 @see #[method||field] 即可
2. 跳转到网址
/**
*  xxx 路径一定要带 http 或者 https 
*  @see <a href="http://www.xxx.com">这是一个网址</a>
*/
  • 4
    点赞
  • 9
    收藏
    觉得还不错? 一键收藏
  • 2
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值