在编写代码时,总会要求在方法或者类上添加注释,一是为了提高代码书写质量,便于清楚地认知该类或者该方法的作用什么,是干什么的;二是为了使代码看起来更加美观;所以要使用注释模板,更好的对方法进行描述。
类注释模板
修改位置:
模板:
/**
*
* @author user
* @date ${DATE} ${TIME}
**/
作者:user 可以改为你自己的名字
方法注释模板
修改位置:
在Java右侧的 + 可以创建一个新的模板,我这里为 * 描述为method
模板:
*
* @author user $data$$param$ $return$
*/
1、如果下方出现警示,点击,选择 EveryWhere
2、点击左边的 Edit variables,对变量进行编辑
date:time("yyyy-MM-dd")
param:groovyScript("def result = '';def params = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n ' : '')}; return result == '' ? null : '\\r\\n ' + result", methodParameters())
return:groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())
效果
类:
/**
* 《描述》
* @author user
* @date 2021/11/17 10:50
**/
方法:
/**
*《描述》
*
* @param 请求参数
* @return 返回结果
* @author user 2021-11-17
*/