自动添加类注释
效果:
/**
* @author xc
* @description TODO
* @create 2023-02-27 09:19
*/
public class Test3 {
}
在IDEA的设置中进行操作:
/**
* @description TODO
* @author xc
* @create ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
*/
还可以根据自己喜欢,修改内容
/**
* @PACKAGE_NAME: ${PACKAGE_NAME}
* @CLASS_NAME: ${NAME}
* @USER: ${USER} (这里是pc的当前用户名)
* @DATE: ${DATE}
* @TIME: ${TIME}
* @YEAR: ${YEAR}
* @MONTH: ${MONTH}
* @MONTH_NAME_SHORT: ${MONTH_NAME_SHORT}
* @MONTH_NAME_FULL: ${MONTH_NAME_FULL}
* @DAY: ${DAY}
* @DAY_NAME_SHORT: ${DAY_NAME_SHORT}
* @DAY_NAME_FULL: ${DAY_NAME_FULL}
* @HOUR: ${HOUR}
* @MINUTE: ${MINUTE}
* @PROJECT_NAME: ${PROJECT_NAME}
*/
示例:
/**
* @PACKAGE_NAME: com.itszt.demo1
* @CLASS_NAME: Test4
* @USER: wxcican
* @DATE: 2023/2/27
* @TIME: 09:31
* @YEAR: 2023
* @MONTH: 02
* @MONTH_NAME_SHORT: 2月
* @MONTH_NAME_FULL: 二月
* @DAY: 27
* @DAY_NAME_SHORT: 周一
* @DAY_NAME_FULL: 星期一
* @HOUR: 09
* @MINUTE: 31
* @PROJECT_NAME: demo01
*/
设置方法注释模版
效果:
/**
* @param a
* @description
* @author xc
* @date 2023/2/27 09:39
*/
public void test(int a) {
}
在IDEA设置中进行操作:
贴上我自己常用的模版,可以根据自己喜好来调整
使用时只需要在方法上一行输入,/** + Enter,就ok
**
$param$
$returns$
* @description $description$
* @author xc
* @date $date$ $time$
*/
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 : result", methodParameters())
returns:groovyScript("def returnType = \"${_1}\"; def result ='';if(returnType=='null'||returnType=='void'){return;}else{result += '* @return ';cls = returnType.split('<');for(i = 0; i < cls.size(); i++){temp = cls[i].tokenize('.');result += temp[temp.size() - 1] + ((i < cls.size() - 1) ? '<' : '');};return result + ' ';}", methodReturnType());