1、类方法注解模板
路径在这里：File–>settings–>Editor–>File and Code Templates–>Files
先来了解一下类注解里几个关键标签的含义：
@BelongsProject：用来标注项目名。@BelongsPackage：填写当前类的包路径。@Author：作者姓名，这个不用多说。@CreateTime：记录类的创建时间，模板会自动填充。@Description：给这个类写个简要说明，通常先写个“TODO”占位。@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: Ja va-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: ja va.util.List
**/
public List Test2(){
ArrayList
3、方法注解模板(二)
1.1 模板
如果你觉得第一种模板的格式不够紧凑，可以试试第二种。这种模板把参数和返回值信息都放在`@date`标签后面，看起来更简洁。
* * @description: * @author: zhengyuzhu * @date: $date$ $time$ $param$ $return$ **/
先看看效果：
设置过程和第一种模板大同小异，主要是模板内容和“获取方法”的表达式需要调整。
具体步骤参考下图：
核心在这里：自定义“获取方法”表达式。你需要将下面几段Groovy脚本分别填入对应的位置。
1. 用于获取参数的自定义方法：
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())
2. 用于获取返回值（包含完整包名）的自定义方法：
groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return: ' + \"${_1}\"", methodReturnType())
3. 用于获取返回值（不包含包名，只取类名）的自定义方法：
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: ja va.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: ja va.util.List
**/
public List list (int a ,String b){
return null;
}
总结
好了，以上就是关于IDEA中自定义类和方法注解模板的详细配置过程。两种方法模板各有特点，第一种条理清晰，第二种紧凑高效，选择哪种全看你的编码习惯。希望这份经验能帮你提升开发效率，让代码注释更加规范美观。
您可能感兴趣的文章:
- IDEA 自定义方法注解模板的实现方法
- 详解IntelliJ IDEA 自定义方法注解模板
