IDEA类和方法注释模板设置
1、在类上设置注释的模板
File-->settings-->Editor-->File and Code Templates-->Files
选择CLASS,如果没有选择File 下面的+ 进行添加
内容
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end #parse("File Header.java") /** * @author : * @date :${DATE} ${TIME} * @description : * @modyified By: */ public class ${NAME} { }
如果添加右下角的Apply 即可
2、 File-->Settings-->Editor-->Live Templates
选择新增分组,
然后新增具体的模板
Abbreviation 的值设置为* ,Description 为add comment for method ,
Template text
* * 功能描述: * @Param: $param$ * @Return: $return$ * @Author: $author$ * @Date: $date$ $time$ * @Description: */
选择作用的位置
勾选java
下面设置默认值
param 设置的Default Value为
groovyScript("def result='\\n'; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(i == 0 && params[i] == ''){return '';};result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : ' ')}; return result", methodParameters())
return 设置为
methodReturnType()
date 设置为date()
time 位置为time()
生成后的
/** * 功能描述: * @Param: * @param code * @param msgParams * @param throwable * @Return: * @Author: * @Date: 2020/11/26 14:44 * @Description: */ @Deprecated public BusinessException(String code,String [] msgParams,Throwable throwable) { }
如果嫌弃@Param生成的不好看则设置为 methodParameters()
@return 也可以设置为groovy脚本
groovyScript("def params=\"${_1}\"; if(params=='void'){return '';} else {return '\\n\t * @return ' + params}", methodReturnType())