一、类注释
1、打开设置
打开设置:Settings->Editor->File and Code Templates,如下图。
File Header.java为引用的模板文件
类头文件注释模板(File Header.java)
/*** @title ${NAME}* @date ${DATE} ${TIME}* @author you-ni* @description TODO*/
二、方法注释
1、打开设置
打开设置:Settings->Editor->File and Code Templates,如下图创建一个模板组,自定义名称
选择创建好的模板组,在模板组中创建一个实时模板
注意使用方法注释需要在 方法内 进行,否则会显示 Null
最后哪里说错了,需要在方法下面**+Enter键生成
/** @Description //TODO $end$* @Date $time$ $date$* @Param $param$* @return $return$**/
下图为第五步中的参数配置
最终效果图:
下面这两个配置是替代 param 和 return 表达示的另一种配置,可根据喜好选择搭配。
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())groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())