鲁班小技巧简友广场简友圈

在IDEA中添加类注释与方法注释模板

2019-06-09  本文已影响110人  等闲阁

1.类注释

在IDEA中依次选择File-->Settings-->File and code Template-->Files-->class
在选择的class中添加如下注释

/**
* @ClassName : ${NAME}  //类名
* @Description : ${description}  //描述
* @Author : HTB  //作者
* @Date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}  //时间
*/

如下图


QQ截图20190528134618.png

保存成功后在创建类的时候会出现填写描述的框


QQ截图20190609145528.png
设置完成后的效果:
QQ截图20190528134655.png

2.方法注释

在IDEA中依次选择 File-->Settings-->Live Template--->Template Group


QQ截图20190528135028.png

组名随便填,在创建完组后在该组下边创建模板(模板名为*,为了方便使用快捷键)


QQ截图20190528135138.png
QQ截图20190528135321.png
依次填入前缀,描述, Template text 与Edit variables

在Template text中填入模板规格 如下:

**
* @Param $param$ //参数
* @description $description$  //描述
* @author HTB //作者
* @date $date$ $TIME$ //时间
* @return $return$  //返回值
* @throws $throws$  //异常
*/

在Edit variables中打勾选择


QQ截图20190528200313.png

点击ok,完成后在方法上使用快捷键(/前缀+Tab)快速生成注释
效果如下:


QQ截图20190609151248.png
上一篇下一篇

猜你喜欢

热点阅读