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个性化设置注释模板内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • java开发AOP基础JdkDynamicAopProxy

    java开发AOP基础JdkDynamicAopProxy

    这篇文章主要为大家介绍了java开发AOP基础JdkDynamicAopProxy源码示例解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-07-07
  • 当Mybatis遇上目录树超全完美解决方案

    当Mybatis遇上目录树超全完美解决方案

    这篇文章主要介绍了当Mybatis遇上目录树有哪些解决方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-04-04
  • Java对象级别与类级别的同步锁synchronized语法示例

    Java对象级别与类级别的同步锁synchronized语法示例

    这篇文章主要为大家介绍了Java对象级别与类级别的同步锁synchronized语法示例,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步
    2022-03-03
  • Java实现截图小工具的完整代码

    Java实现截图小工具的完整代码

    这篇文章主要介绍了Java实现截图小工具的完整代码,用Java的图形用户界面GUI技术写了一个电脑截图小工具,本程序代码简单,涉及到异常处理,事件处理,图形用户界面等,需要的朋友可以参考下
    2022-05-05
  • 一文详解SpringBoot如何同时监听多个端口

    一文详解SpringBoot如何同时监听多个端口

    这篇文章主要为大家详细介绍了SpringBoot如何同时监听多个端口,文中的示例代码讲解详细,具有一定的借鉴价值,感兴趣的小伙伴可以了解下
    2025-10-10
  • Echarts+SpringMvc显示后台实时数据

    Echarts+SpringMvc显示后台实时数据

    这篇文章主要为大家详细介绍了Echarts+SpringMvc显示后台实时数据,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-12-12
  • SpringCloud+Tornado基于jwt实现请求安全校验功能

    SpringCloud+Tornado基于jwt实现请求安全校验功能

    这篇文章主要介绍了SpringCloud+Tornado基于jwt实现请求安全校验,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-12-12
  • JAVA Spring Boot 自动配置实现原理详解

    JAVA Spring Boot 自动配置实现原理详解

    这篇文章主要介绍了详解SpringBoot自动配置原理,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2021-09-09
  • SpringCloud Gateway动态路由配置详解

    SpringCloud Gateway动态路由配置详解

    这篇文章主要为大家介绍了SpringCloud Gateway动态路由配置详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-03-03
  • java中SynchronizedList和Vector的区别详解

    java中SynchronizedList和Vector的区别详解

    这篇文章主要介绍了java中SynchronizedList和Vector的区别详解,Vector是java.util包中的一个类。 SynchronizedList是java.util.Collections中的一个静态内部类。,需要的朋友可以参考下
    2019-06-06

最新评论