idea：java注释模板配置

idea：java注释模板配置

1 类注释模板配置

idea下，File->Settings->Editor->File and Code Template

类注释选择Class：

类注释模板修改如下（idea输入/**，再按下enter，可快捷生成多行注释）：

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
 * @author xiaoxu 
 * @date ${YEAR}-${MONTH}-${DAY} ${TIME}
 * ${PROJECT_NAME}:${PACKAGE_NAME}.${NAME}
 */
public class ${NAME} {
}

新建类，效果如下：

package com.base2;

/**
 * @author xiaoxu
 * @date 2021-11-13 12:53
 * learn_java:com.base2.TestZS
 */
public class TestZS {
}

2 方法注释模板配置

选择File->Settings->Editor->Live Templates->Template Group:




2.1 方法注释模板配置方式一：

方法注释模板如下：

/**
 * @version v1.0
 * @throw 
 * @description 
 * @param $params$
 * @return $return$
 * @since $DATE$ $time$
 */

编辑变量的值：

指定模板的语言：


使用：
新建一个类，及其方法：

package com.base2;

public class WE {
    public void runMe(String name,int age){
        System.out.println("名称："+name+"  "+"年龄："+age);
    }
}

（1）在方法外部使用：


以上变量编辑方式，在方法外部进行方法注释，会缺失param和return

（2）在方法内部使用：

参数和返回值在函数作用域内，idea才可以找到相应的值。使用自带的函数，多个参数以数组形式展示，如果希望参数自定义多个分别展示，可采用第二种方式。

2.2 方法注释模板配置方式二：

方法注释模板如下（同方式一）：

/**
 * @version v1.0
 * @throw 
 * @description 
 * @param $params$
 * @return $return$
 * @since $DATE$ $time$
 */

修改模板变量的params和return的表达式：

表达式如下：
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==0){result+=params[i]}else{result+='\\n ' + '* @param ' + params[i]}}; return result;}", methodParameters());

return：

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

（1）在方法外部使用（使用的时候m+tab即可（m指上述定义的快捷键method_note），不要按其他的键，如enter，否则会影响模板的布局）：

同方式一，在外部，idea无法拿到方法的参数和返回值。

（2）在方法内部使用：


参数和返回值在函数作用域内，idea可找到值，且多个参数是分别展示的。