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

 更新时间:2026年04月23日 08:47:51   作者:乡下小哥编程  
本文主要讲述了在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;
    }

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Spring Boot集成Milvus快速入门demo示例详解

    Spring Boot集成Milvus快速入门demo示例详解

    Milvus是一种高性能向量数据库,支持从笔记本到大型分布式系统的多环境运行,它以开源和云服务形式提供,是LFAI & Data Foundation的项目,采用Apache 2.0许可,Milvus特别支持高并行化和解耦的系统架构,使其能够随数据增长而扩展,支持各种复杂搜索功能,满足企业级AI应用需求
    2024-09-09
  • Java实现可配置换肤的方法示例

    Java实现可配置换肤的方法示例

    本文主要介绍了Java实现可配置换肤的方法示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-06-06
  • Java 多线程核心组件关键特征对比与实战指南

    Java 多线程核心组件关键特征对比与实战指南

    本文详细对比了Java多线程核心组件,包括Runnable、Callable、Future、CompletableFuture、ExecutorService、CountDownLatch、CyclicBarrier、Semaphore和ConcurrentHashMap等,并提供了最佳实践和性能优化建议,感兴趣的朋友跟随小编一起看看吧
    2025-12-12
  • 如何将DeepSeek 集成到 Java 的 Spring Boot 项目中

    如何将DeepSeek 集成到 Java 的 Spring Boot&

    本文介绍了如何将DeepSeek集成到Java的SpringBoot项目中,包括准备工作、集成步骤和示例说明,感兴趣的朋友一起看看吧
    2025-02-02
  • Java实现读取CSV文件数据内容(含逗号处理)

    Java实现读取CSV文件数据内容(含逗号处理)

    这篇文章主要为大家详细介绍了如何使用Java实现读取CSV文件数据内容,包含了逗号处理,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2025-07-07
  • Java中Integer类常用静态方法实例详解

    Java中Integer类常用静态方法实例详解

    在Java编程中Integer类是int基本类型的封装类,提供了许多方便的功能,这篇文章主要介绍了Java中Integer类常用静态方法的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2025-07-07
  • SpringBoot高级配置之临时属性、配置文件、日志、多环境配置详解

    SpringBoot高级配置之临时属性、配置文件、日志、多环境配置详解

    这篇文章主要介绍了SpringBoot高级配置之临时属性、配置文件、日志、多环境配置,本文结合实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-02-02
  • Java 利用枚举实现接口进行统一管理

    Java 利用枚举实现接口进行统一管理

    这篇文章主要介绍了Java 利用枚举实现接口进行统一管理,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-02-02
  • java实现远程连接执行命令行与上传下载文件

    java实现远程连接执行命令行与上传下载文件

    这篇文章主要介绍了java实现远程连接执行命令行与上传下载文件方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-05-05
  • GateWay动态路由与负载均衡详细介绍

    GateWay动态路由与负载均衡详细介绍

    这篇文章主要介绍了GateWay动态路由与负载均衡,GateWay支持自动从注册中心中获取服务列表并访问,即所谓的动态路由
    2022-11-11

最新评论