IDEA添加JavaDOC注释 方法 快捷键

本文介绍两种在IDE中快速为Java类或方法生成JavaDoc注释的方法。第一种是通过设置快捷键实现一键生成;第二种是在类名或方法名上使用快捷菜单添加JavaDoc。此外,还介绍了link标签的基本用法。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

第一种方法:

默认Fix doc comment是没有设置快捷键的,我这里把他设置成Alt + M。

200126_Le9R_2885163.png

200141_cer4_2885163.png


然后鼠标光标停留在需要注释的方法名上,按此快捷键即可生成注释文档。

第二种方法:

  1. 把光标停在类名或者方法名上,然后Alt+enter,出现几个选项,选择Add Javadoc就OK了。
    200154_V4HC_2885163.png

    添加注释

注解中的标签

link标签

link使用格式如下:
{@link[<package>.]<class>[#<method>]}
{@link#<method>}

调用示例:使用link链接一个类

200207_n71D_2885163.png

使用link链接一个方法:{@link Test#test()} 使用link链接本类中方法:{@link #test()}

更多JavaDoc标签的使用可以参考Oracle的javadoc文档: http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html



作者:清净安宁
链接:http://www.jianshu.com/p/10aef35bb6c5
來源:简书
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。

转载于:https://my.oschina.net/zjllovecode/blog/1510055

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值