IDEA为类和方法设置注解模板过程
作者：乡下小哥编程
本文主要讲述了在IntelliJ IDEA中创建类和方法注解模板的步骤与实际效果,并提供了两种方法注解模板的具体实现过程,通过自定义模板,用户可以自动化地生成类和方法的注释,提高开发效率
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;
}
总结
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。