Java系列之 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;
    }
相关文章
|
4天前
|
Linux Android开发 Windows
IDEA如何设置成Eclipse的快捷键
【10月更文挑战第9天】这段内容介绍了如何在 IntelliJ IDEA 中设置类似 Eclipse 的快捷键。主要包括:1) 打开设置;2) 进入快捷键设置页面;3) 选择 Eclipse 快捷键方案;4) 可选的自定义调整。通过这些步骤,可以让熟悉 Eclipse 的用户更快适应 IDEA。
|
1天前
|
Java
Java PDF模板生成PDF
Java PDF模板生成PDF
|
5天前
|
JSON Java 数据库
java 常用注解大全、注解笔记
关于Java常用注解的大全和笔记,涵盖了实体类、JSON处理、HTTP请求映射等多个方面的注解使用。
10 0
java 常用注解大全、注解笔记
|
1月前
|
Arthas Java 测试技术
Java字节码文件、组成,jclasslib插件、阿里arthas工具,Java注解
Java字节码文件、组成、详解、分析;常用工具,jclasslib插件、阿里arthas工具;如何定位线上问题;Java注解
Java字节码文件、组成,jclasslib插件、阿里arthas工具,Java注解
|
18天前
|
Java 应用服务中间件 Spring
IDEA 工具 启动 spring boot 的 main 方法报错。已解决
IDEA 工具 启动 spring boot 的 main 方法报错。已解决
|
17天前
|
Java 编译器 程序员
Java注解,元注解,自定义注解的使用
本文讲解了Java中注解的概念和作用,包括基本注解的用法(@Override, @Deprecated, @SuppressWarnings, @SafeVarargs, @FunctionalInterface),Java提供的元注解(@Retention, @Target, @Documented, @Inherited),以及如何自定义注解并通过反射获取注解信息。
Java注解,元注解,自定义注解的使用
|
1天前
|
XML Java 数据格式
Java-spring注解的作用
Java-spring注解的作用
|
1天前
|
小程序
java--微信小程序发送模板消息
java--微信小程序发送模板消息
|
2天前
|
关系型数据库 MySQL Java
【IDEA】java后台操作mysql数据库驱动常见错误解决方案
【IDEA】java后台操作mysql数据库驱动常见错误解决方案
12 0
|
4天前
|
人工智能 Java 数据库连接
IDEA开发 常用代码规范插件 常用辅助类插件
IDEA开发 常用代码规范插件 常用辅助类插件
16 0

热门文章

最新文章