idea设置类注释和方法注释（方法注释含参数返回值）

idea设置类注释和方法注释（方法注释含参数返回值）

如题主要是为了以后方便查阅。

一、类的注释模板和配置

1.步骤一：打开Idea，在菜单栏中找到 File ->setting -> File and Code Templates 后点击，选择右侧的Class，出现以下界面：

2,.步骤二：将类注释模板写到图中位置，其中${USER}是获取电脑用户名，如果不想使用也可以自定义

/**
* @program: ${PROJECT_NAME}
* @description: ${description}
* @author: ${USER}
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/

下面是效果图

二、方法注释（含参数和返回值 方法外可获取）

1.步骤一：打开Idea，在菜单栏中找到 File ->setting -> Live Templates 后点击，出现以下界面：

2.步骤二：我们需要创建自己的模板组，所以我们点击图中的 + 按钮（在右边），选择 Template Group…，输入我们自定义方法模板组的名称，这里我创建的名称是myannotation，然后点击ok，效果图如下：

3.选中模板组，然后再次点击右边的 + 按钮，选择 Live Template，效果图如下：

通过修改图中的Abbreviation参数来设置我们自定义方法模板的快捷键，通过修改Description来标明模板用途

4.在Template text填写注释模板

/**
 * @param: $param$
 * @return: $return$
 * @auther: $user$
 * @date: $date$ $time$
 */

5.步骤五：下面是重点了 ，点击 Edit variables 按钮，弹出参数配置页面）

其中最主要的param的配置，如果想要的效果是多个入参能够一行一个的展示，我们需要通过groovy脚本语言来定义param中的Default value，将脚本语言粘贴进去就可以了，脚本语言：

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

然后各个参数配置完成 一路OK就可以了
6.步骤六：最后点击图中最下方的 Define 按钮来设置模板作用的语言范围因为我这已经设置过了 所以没有

下面是效果图：