IDEA20.1配置方法注释

根据阿里开发手册，我稍微整理了一下模板规范，及Idea配置模板步骤。

注释的种类

/**
 * 多行注释1
 * 文档注释
 */

// 单行注释2 枚举、参数等
        
/*
方法内部使用多行注释3
方法块注释
 */

注释使用规范 摘自阿里开发手册

IDEA方法模板注释

一、打开idea 点击菜单File->Setting-Editor->Live Template

选择Editor

点击Live Template，选择新建分组Template Group 起一个你喜欢的组名点击ok

二、选择Live Template 添加快键键缩写

我这边是*，添加说明：方法注释，将方法注释模板放置在下方Template Text中。

注释模板代码

初次配置会出现Define，再次会出现Change。直接勾选java即可

三、配置Edit variables

当我们配置Expression时点击填写参数下拉框会有对应配置供我们选择，完成后 注意到下方有个Expand with 这边enter是联合我们的缩写的一个快捷键，可根据自己需求设置

四、配置入参和返回字段的default value

否则会出现入参和返回类型为null的情况。

//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  : )}; return result", methodParameters());
//return 此行无虚复制
groovyScript("if("${_1}" == void){def result = } else { def returnType = "${_1}"; def result = \r\n * @return:  + returnType; return result;}", methodReturnType());

点击Apply 进行引用，ok关闭页面，下一步开始使用

五、开始使用

输入 /** 回车 即可。 效果如下

package com.hzx.study.demo;

/**
 * @ClassName：aa
 * @Author: gouteng
 * @Date: 2022/2/17 10:53 PM
 * @Description: 必须描述方法做什么事情, 实现什么功能
 */
public class aa {
          
   
   
   /**
    * @Description:
    * @data:[aa, bb] 
    * @return: int
    * @Author: hzx
    * @Date: 2022-02-48 23:33:24
    */
    public int test(String aa,String bb){
          
   
        return 1;
    }
}

IDEA类注释模板

idea -> File ->setting->Editor->File and code Templates

找到Class根据下方代码配置到图中所示位置 点击Apply ok即可。

/**
* @ClassName：$NAME
* @Author: gouteng
* @Date: $DATE $TIME
* @Description: 必须描述类做什么事情,实现什么功能
*/