Idea设置类和方法注释模板
设置Java类注释模板
-
找到设置面板,具体界面如下图所示:
路径:【File】→【Settings】→【Editor】 →【 File and Code Templates】→【Files】 →【Class】
-
设置类注解模板
类注释模板
/** * * @class: ${NAME} // 注释所在的类名 * @author: Keiissland * @mail: [email protected] * @date: ${DATE} ${TIME} // idea自动识别 * @description: ${end} // 类创建完成后,紧接着会让你输入“end”的内容。创建类,描述类一起喝成 * @version 1.0 */
将类注释模板添加到设置页面指定的位置,如下图所示:
注意:如果勾选了上图红框中的“Reformat according to style”,那么Idea会自动调整注释模板格式,从而将@version调整到第一行。所以,此处可根据自己的需求,选择性的勾选该自动排版功能。 -
新建类检测效果
/** * @class: HelloWorld * @author: Keiissland * @mail: [email protected] * @date: 2019/12/10 22:01 * @description: 永远的Hello World ! * @version 1.0 */ public class HelloWorld { }
设置Java方法注释模板
-
找到设置面板,具体界面如下图所示:
路径:【File】→【Settings】 →【Editor】 →【Live Templates】
-
点击上述界面红框中的“Template Group”,创建自己的一个Group(名字随意)。本文以“MyGroup”为例,创建完成后如下图所示:
-
为MyGroup创建一个Live Template,具体操作如下图所示:
-
设置Live Template相关配置,具体界面如下图所示:
其中 Template text 文本格式内容如下(用户可根据自身需求调整, 的缩减不能动):* * @author Keiissland * @description $params$ * @return $return$ */
说明(红框内容)
- Abbreviation表示方法注释模板快捷生成引导字符,即通过“* + Tab“组合按键生成注释模板
- Expand with表示触发注释模板生成的按键,默认为“Tab”键(Abbreviation + Expand with完成注释模板的快速生成)
注意
-
Abbreviation不要以 “/*” 开发,否则后续 参数列表无法获取,导致模板效果有偏差
-
勾选红框中的“Reformat according to style”,Idea自动调整注释模板的缩减问题
-
点击上图红框中的“Edit variables”按键,设置 Template text 文本中的参数( 、 ),具体设置如下图所示:
说明
-
params 参数通过指定的groovy脚本完成params的逐行展示,感兴趣的同学可以尝试读一下,其原理在通过idea内置表达式methodParameters()获取参数列表,然后解析逐行展示。具体脚本如下:
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) ? '\\r\\n' : '') }; return result", methodParameters())
压缩成一行后:
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) ? '\\r\\n' : '')}; return result", methodParameters())
切记:该groovy脚本是和上述给定的模板配套使用的,如果格式不同可能导致效果有偏差
-
return 参数可以直接通过idea内置表达式 methodReturnType() 获取
-
-
设置生效文件,只有被Define的文件类型,才能通过组合按键触发注释模板的生成,界面如下图所示:
说明- 点击红框中的“Define”,勾选弹出框中需要设置方法注释模板的文件类型,Java程序员一般只需勾选“Java”即可
-
新建方法测试效果
/** * @author Keissland * @description * @param param1 * @param param2 * @return java.lang.Integer */ public Integer helloWorld(Integer param1, Integer param2) { return param1 + param2; }