类注释模板

1、File-->settings-->Editor-->File and Code Templates-->Files
我们选择Class文件(当然你要设置接口的还也可以选择Interface文件);
下面附上IDEA内置的一些变量的说明,根据自己的需求添加即可.


样式:

/**
 * @ClassName ${NAME}.java
 * @ProjectName ${PROJECT_NAME}
 */

效果:

/**
 * @ClassName Test.java
 * @ProjectName demo
 */

方法注释模板

1、创建模板
IDEA还没有智能到自动为我们创建方法注释,这就是要我们手动为方法添加注释,使用Eclipse时我们生成注释的习惯是/**+Enter,这里我们也按照这种习惯来设置IDEA的方法注释;
1、File-->Settings-->Editor-->Live Templates
(1)新建组:命名为userDefine;
(2)新建模板:命名为*
因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为/*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、获取方法返回值的methodReturnType()
2、设置模板内容-IDEA格式模板(JavaDoc格式)
注意第一行,只有一个*而不是/*,如果前面加了/会获取不到参数.
在设置参数名时必须用${参数名}$的方式,否则第五步中读取不到你设置的参数名.
样式:

*
 * @Description //TODO $param$ $return$
*/

3、设置参数
JavaDoc格式的需要自定义参数以及返回值的实现方式,分别填入param和return对应的默认值:
获取参数(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())

效果:

/**
* @Description 获取用户基本信息
* @param type
* @param idNumber
* @return UserBaseInfo
*/
最后修改:2022 年 02 月 25 日
给我一点小钱钱也很高兴啦!o(* ̄▽ ̄*)ブ