IDEA个性化设置注释模板详细讲解版

 更新时间:2024年01月28日 09:13:35   作者:律二萌萌哒  
IDEA自带的注释模板不是太好用,我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家,下面这篇文章主要给大家介绍了IDEA个性化设置注释模板的相关资料,需要的朋友可以参考下

IDEA设置注释模板

  • 类注释模板
  • 方法注释模板
  • 效果展示

1. 类注释模板

类注释模板是IDEA创建类时生成的注释

第一步、File -> Settings

第二步、Editor -> File and Code Templates -> Includes -> File Header

点apply,再点ok即可

模板参考如下:

/*
 *@title $NAME
 *@description
 *@author $USER
 *@version 1.0
 *@create $DATE $TIME
*/

2. 方法注释模板

按照 /**+Enter 来设置IDEA的方法注释

步骤

第一步、File -> Settings

第二步、选择“Editor”->“Live Templates”。

第三步、点击右侧的“+”->"Template Group…"添加组。

第四步、命名组

第五步、点击右侧的“+”->"Live Template"添加模板。

第六步、配置注释模板。

①设置一个缩写,此处设置的缩写是/**,在方法上面输入/**然后按补全键就可以按照模板生成注释了。

②对新建模板的描述

③配置的注释模板

④设置补全键

模板格式如下

**
 * @description
 * @author $user$
 $param$
 * @throws $throws$
 $return$
 * @time $date$ $time$
 */

⑤设置在哪些文件中应用此注释模板(不同类型的文件,注释符号是不一样的)

在这里插入图片描述

⑥设置模板中参数的取值

勾选每一行最后的“Skip if defined”

param和return根据自己的模板DIY了一下,如果不想用默认的,我的放在下面了。

param

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

return

groovyScript("def returnType = \"${_1}\"; def result ='';if(returnType=='null'||returnType=='void'){return;}else{result += '* @return ';cls = returnType.split('<');for(i = 0; i < cls.size(); i++){temp = cls[i].tokenize('.');result += temp[temp.size() - 1] + ((i < cls.size() - 1) ? '<' : '');};return result + ' ';}", methodReturnType());

第七步、最后别忘了点击“Apply”和“OK”保存设置。

3. 效果展示

总结 

到此这篇关于IDEA个性化设置注释模板的文章就介绍到这了,更多相关IDEA个性化设置注释模板内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • springboot单独使用feign简化接口调用方式

    springboot单独使用feign简化接口调用方式

    这篇文章主要介绍了springboot单独使用feign简化接口调用方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03
  • SpringBoot自定义对象参数实现自动类型转换与格式化

    SpringBoot自定义对象参数实现自动类型转换与格式化

    SpringBoot 通过自定义对象参数,可以实现自动类型转换与格式化,并可以级联封装,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习吧
    2022-09-09
  • Mybatis-Plus中的MetaObjectHandler组件的使用

    Mybatis-Plus中的MetaObjectHandler组件的使用

    MetaObjectHandler是Mybatis-Plus中一个实用组件,专门用于自动处理实体对象中的特定字段,如创建时间、更新时间、创建人和修改人等,该接口允许开发者在不修改业务代码的情况下,实现自动填充功能,极大地简化了代码的复杂性,感兴趣的可以了解一下
    2024-10-10
  • springBoot使用openfeign来远程调用的实现

    springBoot使用openfeign来远程调用的实现

    这篇文章主要介绍了springBoot使用openfeign来远程调用的实现方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03
  • 详解Java8 新特性之日期API

    详解Java8 新特性之日期API

    Java 8 在包java.time下包含了一组全新的时间日期API。下面通过示例给大家讲解java8 新特征日期api的相关知识,感兴趣的朋友一起看看吧
    2017-07-07
  • Java数据结构之加权无向图的设计实现

    Java数据结构之加权无向图的设计实现

    加权无向图是一种为每条边关联一个权重值或是成本的图模型。这种图能够自然地表示许多应用。这篇文章主要介绍了加权无向图的设计与实现,感兴趣的可以了解一下
    2022-11-11
  • MyBatis-Plus高级扩展详解

    MyBatis-Plus高级扩展详解

    本文介绍了MyBatis-Plus中逻辑删除和乐观锁的实现概念、方法和示例,逻辑删除通过更改记录状态模拟删除,而乐观锁通过版本号或时间戳确保并发操作的正确性
    2025-03-03
  • Java中对象的比较操作实例分析

    Java中对象的比较操作实例分析

    这篇文章主要介绍了Java中对象的比较操作,结合实例形式分析了java对象比较操作实现方法与相关操作注意事项,需要的朋友可以参考下
    2019-08-08
  • Java动态代理之拦截器的应用

    Java动态代理之拦截器的应用

    今天小编就为大家分享一篇关于Java动态代理之拦截器的应用,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-01-01
  • Java 实战项目之家居购物商城系统详解流程

    Java 实战项目之家居购物商城系统详解流程

    读万卷书不如行万里路,只学书上的理论是远远不够的,只有在实战中才能获得能力的提升,本篇文章手把手带你用Java实现一个家居购物商城系统,大家可以在过程中查缺补漏,提升水平
    2021-11-11

最新评论