IDEA类和方法注释模板设置

一、设置类注释模板:

设置成功后,IDEA中在创建类时会自动给添加注释。
1、File–>settings–>Editor–>File and Code Templates–>Files ,选择Class文件,如需设置接口的还也可以选择Interface文件。
(1)ClassName:设置类名,与下面的ClassName一样才能获取到创建的类名;
(2)TODO:代办事项的标记,一般生成类或方法都需要添加描述;
(3)Author:设置创建类的用户;
(4)Date:创建的日期和时间;
还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用PROJECT_NAME。
(5)Version:设置版本号,一般新创建的类都是1.0版本,这里写死即可。
在这里插入图片描述
2、效果图展示:
在这里插入图片描述

二、设置方法注释模板:

1、File–>Settings–>Editor–>Live Templates
在这里插入图片描述
(1)新建组:命名为MyGroup
在这里插入图片描述
(2)新建模板:命名为 *
因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为 /*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters(),获取方法返回值的methodReturnType()。
在这里插入图片描述
(3)设置模板内容:
注意内容第一行,只有一个 *
在设置参数名时必须用 ${参数名} 的方式,否则第五步中读取不到你设置的参数名。

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

(4)设置模板的应用场景:
设置将模板应用于哪些场景,一般选择EveryWhere–>Java即可。不设置也可以。(如果曾经修改过,则显示为change而不是define)
在这里插入图片描述
勾选Java。
在这里插入图片描述
(5)设置参数的获取方式:
选择右侧的Edit variables按钮。
在这里插入图片描述
选择每个参数对应的获取方法(在下拉选择框中选择即可)
(6)设置生成注释的快捷键:
这里我选择的是按Tab键。
在这里插入图片描述
(7)效果图:
在Java类中创建一个方法,在方法上输入 /** + 按Tab键。
在这里插入图片描述
如有错误之处,请小伙伴们多多指正!谢谢

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值