类和方法注释模板设置

一、类模板设置:
1、File–>settings–>Editor–>File and Code Templates–>Files,选择class文件。
(1)${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名
(2)TODO:代办事项的标记,一般生成类或方法都需要添加描述
(3) ${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间
(4)1.0:设置版本号
在这里插入图片描述
2、效果图:
在这里插入图片描述
二、方法模板设置:
1、File–>Settings–>Editor–>Live Templates
在这里插入图片描述
(1)新建组:命名为userDefine
在这里插入图片描述
(2)新建模板:命名为/*
在这里插入图片描述
(3)设置生成注释的快捷键
在这里插入图片描述
(4)设置模板:模板内容如下

/**
 * @Description: 
 * @Author: $user$
 * @Date: $date$ $time$
 $param$
 * @Return: $return$
 */

(5)设置模板的应用场景:点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere–>Java即可。如果曾经修改过,则显示为change而不是define
在这里插入图片描述
(6)设置参数的获取方式:选择右侧的Edit variables按钮
在这里插入图片描述
选择每个参数对应的获取方法,获取param时使用脚本的方式,在param 对应的Default value列添加以下代码:

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())

在这里插入图片描述
(7)效果图:在方法上面写:/*然后按回车键Enter
在这里插入图片描述

猜你喜欢

转载自blog.csdn.net/lizhiqiang1217/article/details/88758161