IDEA为类和方法设置注解模板过程_Java

1、类方法注解模板

1、file–>settings–>editor–>file and code templates–>files

@belongsproject：项目名
@belongspackage：当前包的名称
@author：作者姓名
@createtime：该类创建的时间
@description：对该类的描述
@version：设置版本号，一般新创建的类都是1.0版本，这里写死就可以了

1.1 模板

将这部分代码放到idea 的指定位置。

/**
*@belongsproject: ${project_name}
*@belongspackage: ${package_name}
*@author: zhengyuzhu
*@createtime: ${year}-${month}-${day}  ${hour}:${minute}
*@description: todo
*@version: 1.0
*/

1.2 实际效果

编写一个类，试一下

/**
 * @belongsproject: java-work-demo
 * @belongspackage: a1多线程.b1超时处理.demo1
 * @author: zhengyuzhu
 * @createtime: 2023-11-14  11:31
 * @description: todo
 * @version: 1.0
 */
public class mytest {
}

2、方法注解模板(一)

1.1 模板

*
 * @description:
 * @author: zhengyuzhu 
 * @date: $date$ $time$
 * @param: $param$
 * @return: $return$
 **/

实现的效果是这样的

具体操作过程如下：

这里注意一点，这里的操作顺序不要弄错了。否则，函数方法可能会读取不到。

1.2 实际效果

    /**
     * @description:
     * @author: zhengyuzhu 
     * @date: 2023/11/14 12:21
     * @param: [a, str]
     * @return: void
     **/
    public void test(int a, string str){
        
    }
    
    /**
     * @description:
     * @author: zhengyuzhu 
     * @date: 2023/11/14 12:22
     * @param: []
     * @return: java.util.list
     **/
    public list test2(){
        arraylist<object> list = new arraylist<>();
        return list;
    }

3、方法注解模板(二)

1.1 模板

*
 * @description:
 * @author: zhengyuzhu
 * @date: $date$ $time$ $param$ $return$
 **/

效果展示

具体实现过程，过程和一相似。只需要改变模板，和获取方法就可以了。

具体过程如下：

自定义方法：参数获取

groovyscript("def result = '';def params = \"${_1}\".replaceall('[\\\\[|\\\\]|\\\\s]', '').split(',').tolist(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='* @param: ' + params[i] + ((i < params.size() - 1) ? '\\r\\n ' : '')}; return result == '' ? null : '\\r\\n ' + result", methodparameters())

自定义方法：返回值包含包名

groovyscript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return: ' + \"${_1}\"", methodreturntype())

自定义方法：返回值不包含包名

groovyscript("def result=''; def params=\"${_1}\".replaceall('[\\\\[|\\\\]|\\\\s]', '').split('<').tolist(); for(i = 0; i < params.size(); i++) {if(i!=0){result+='<';};  def p1=params[i].split(',').tolist();  for(i2 = 0; i2 < p1.size(); i2++) { def p2=p1[i2].split('\\\\.').tolist();  result+=p2[p2.size()-1]; if(i2!=p1.size()-1){result+=','}  } ;  };  return result", methodreturntype())

1.2 实际效果

我习惯用返回值包含包名的、根据个人习惯来改。

    /**
     * @description:
     * @author: zhengyuzhu
     * @date: 2023/11/14 12:34 
     * @param: a
     * @param: b
     * @param: c 
     * @return: java.lang.string
     **/
    public string testdemo(int a,string b,list c){
        return null;
    }
    
    
    /**
     * @description:
     * @author: zhengyuzhu
     * @date: 2023/11/14 12:41 
     * @param: a
     * @param: b 
     * @return: java.util.list<java.lang.string>
     **/
    public list<string> list (int a ,string b){
        return null;
    }