idea注释模板：类注释模板、方法注释模板（带参数获取以及参数换行）

本文主要就开发工具idea的注释模板进行一下简单讲解。网上关于这类教程很多，其中类注释模板大家基本都会，但idea自带的方法注释模板有个问题：当方法有多个参数时，多参数以数组集合的方式显示在一行，这样我们便没法解释各个参数的含义。因此，本文主要是演示如何设置多参数换行。

 1 类（接口）注释模板

• 打开file-Setting-Editor-File and Code Templates，然后选中右侧的Files-Class（如果是接口的话，需要选中interface），然后在代码区修改为如图所示即可。

可直接复制如下代码粘贴进去即可 

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
/**
 @基本功能:
 @program:${PROJECT_NAME}
 @author:${USER}
 @create:${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}:${SECOND}
**/
#parse("File Header.java")
public class ${NAME} {
}

效果显示：当我们新建一个类时，可得如下效果

/**
 * @基本功能:
 * @program:summary
 * @author:peicc
 * @create:2019-09-09 11:08:35
 **/
public class Main {
}

2 方法注释模板

相比于类注释模板，方法注释模板要麻烦点，因为它需要设置快捷键（类不需要，创建时自动生成）、获取方法参数、返回值类型以及其他的一些自定义的信息。 

• 打开file-Setting-Editor-LiveTemplates

• 点击最右侧的+号，然后选择 2.Template Group，在弹出的输入框中输入我们自定的组名，如CustomGroup。（此步骤的目的只是为了新建一个组而已，方便下一步我们将新建的方法注释模板归类其中。如果不创建，完全没有任何问题，我们完全可以将之后新建的方法模板添加到已有的组中）

• 选中我们刚刚新建的组CustomGroup，然后再点击右侧的+号，此时选择1.Live Template，然后弹出如图所示的对话框。主要参数设置如图所示。

模板代码如下： 

*** 
 * @函数功能：
 $params$
 * @return：$returns$
 */

•  完成上述设置后，我们再点击Apply。此时我们便完成了对模板的初步设置（你可以点击ok后回到代码区，输入*+enter，会看见就可以输出模板内容了。但此时输出会有问题，因为模板内容以***开头，以*/结尾，所以直接输出的话显示不是注释的格式。正确注释的格式应该是/*开头，*/结尾。因此我们需要先输入/*+enter，这样模板内容就能正确输出了。那么问题来了，为什么我们不把/直接加在模板里面呢？如果我们把/直接加在模板里面的话，此时方法注释只能写在方法内部，如果写在外部，将无法完成方法参数的自动获取，大家可以测试下。）
• 但当模板正确输出后，我们发现自定义的参数字段内容为空，没法自动获取参数。因此我们还需要对变量的值进行设置

• 点击Edit variables按钮，然后弹出如图所示的对话框。主要设置如下 

•  为了让参数分行显示，需要在default Value中进行如下设置

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

•  点击ok,我们便完成了参数的设置。然后我们回到代码区，找到任意一个方法，在其上面输入/*+enter，便可以得到方法的自动注释了，而且参数可以自动获取。

 方法注释效果

/**
 * @基本功能:
 * @program:summary
 * @author:peicc
 * @create:2019-09-09 11:08:35
 **/
public class Main {
    /*** 
     * @函数功能：
     * @param: args
     * @param: a
     * @param: b
     * @return：void
     */
    public static void main(String[] args,int a,int b) {
        
    }
}