AS使用:添加javaDoc注释

本文借鉴学习https://blog.csdn.net/qq_32168785/article/details/109670547
一、安装javaDoc插件
File->Settings->Plugins
搜索javaDoc ,点击 install按钮安装。重启AS,即可以使用javaDoc。
在这里插入图片描述
二、添加类注释
添加类注释实质上是添加类模板
方法:
File–>settings–>Editor–>File and Code Templates–>Files–>Class
在模板上加入文档注释模板

/**
  *@ClassName ${NAME}
  *@Description TODO
  *@Author ${USER}
  *@DATE ${DATE} ${TIME}
  *@Version 1.0 
*/

在这里插入图片描述
在这里插入图片描述
三、在方法上生成文档注释
1、File–>Settings–>Editor–>Live Templates
2、单击右侧“+”号,选择Template Group…,新建一个自定义模板组,可以使用自己的名字命名;
3、选择该模板组,单击右侧“+”号,选择“Live TempLate”,设置“abbreviation”的值为”*”;
4、设置模板内容,选择Temple Text,设置为

*
 * @Author $user$
 * @Description //TODO
 * @Date $time$ $date$
 * @Param $param$
 * @return $return$
 **/

在这里插入图片描述
5、设置该模板在哪些文件生效,选择下方的define-everywhere-java,设置只在java文件中生效

6、选择右侧的Edit variables按钮,进行如下配置
在这里插入图片描述
7、使用/*+刚设置的模板名(此处为我们前面设置的“ * ”)+tab(默认模板补全快捷键,在上方的“By default expand with”设置,此处我更改为了Enter,看个人习惯),所以此时我们使用/** + tab就能补全,效果如下
在这里插入图片描述
本文借鉴学习https://blog.csdn.net/qq_32168785/article/details/109670547

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值