IDEA注释规范

一、Class注释

Preferences > Editor > File and Code Templates > Files
将

• Class
• Interface
• Enum
• Record
• AnnotaionType

 内容都改为：

/**
* ${Describe}
* @author ${USER}
* @DATE ${DATE} ${TIME}
*/

 

二、Method注释

Preferences > Editor > Live Templates

新建一个Live Templates Group 名为 userDefined

 

 

新建一个 Live Templates 

*
* $end$
*
$params$
$retures$
* @author PeiXy_J
* @version 1.0.0.0
* @since $time$ $date$
*/

 

再设置 edit Variables

params ->

groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {if(i<(params.size()-1)){result+=' * @param ' + params[i] + ' ' + '\\n'}else{result+=' * @param ' + params[i] + ' '}}; return result;}", methodParameters()); 

retures->

groovyScript("def returnType = \"${_1}\"; def result = ' * @return ' + returnType; return result;", methodReturnType()); 

 三、验证内容