美观好用的IDEA类和方法注释模板设置

快来打我* 2021-09-01 03:22 652阅读 0赞

## 1.设置类注释模板 ##

**打开file->setting->Editor->File and Code Templates->Includes->File Header**

/** * @Author: dxf * @Description: * @Date: Created in ${YEAR}-${MONTH}-${DAY} ${TIME} * @Modified By: */

/** *@ClassName ${NAME} *@Description TODO *@Author ${USER} *@Date ${DATE} ${TIME} *@Version 1.0 */

这样在定义类时，都要多输入类的描述。不想的话，可以删去 $\{description\}

## 2.方法注释 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjQwODY0OA_size_16_color_FFFFFF_t_70_pic_center]

1、File–>Settings–>Editor–>Live Templates

（1）新建组：命名为userDefine

（2）新建模板：命名为\*\*

因为IDEA生成注释的默认方式是：/+模板名+快捷键（比如若设置模板名为add快捷键用Tab，则生成方式为

/\*\*+Tab）

获取方法返回值的methodReturnType(）

（3）设置生成注释的快捷键

（4）设置模板：模板内容如下

**
     * @Description:
     * @Auther: dxf
     * @Date: $time$ $date$ 
    $param$
     * @Return: $return$
     */

**param参数表达式**

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\\b' : '')}; return result", methodParameters())

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjQwODY0OA_size_16_color_FFFFFF_t_70_pic_center 1]  
**效果**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjQwODY0OA_size_16_color_FFFFFF_t_70_pic_center 2]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjQwODY0OA_size_16_color_FFFFFF_t_70_pic_center]: /images/20210813/35ff8434e0414709b812351167b930fe.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjQwODY0OA_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20210813/9b92addbfb6745ff887967ab08f9df07.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjQwODY0OA_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20210813/385c4c3b26d3423dbc46037203821e9f.png