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实现数组扩容的三种方式
这篇文章主要详细介绍了Java实现数组扩容的三种方式，新建一个数组，把原来数组的内容搬到新数组中，使用system.arraycopy()，使用java.util.Arrays.copyOf()这三种方式，具有一定的参考价值，需要的朋友可以借鉴一下
2023-06-06
SSH框架网上商城项目第15战之线程、定时器同步首页数据
这篇文章主要为大家详细介绍了SSH框架网上商城项目第15战之线程、定时器同步首页数据，感兴趣的小伙伴们可以参考一下
2016-06-06
spring boot创建和数据库关联模块详解
这篇文章主要给大家介绍了关于spring boot创建和数据库关联模块的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-10-10
java 中file.encoding的设置详解
这篇文章主要介绍了java 中file.encoding的设置详解的相关资料,需要的朋友可以参考下
2017-04-04
浅谈Spring的两种配置容器
这篇文章主要介绍了浅谈Spring的两种配置容器，介绍了其实现以及简单的实例，具有一定参考价值，需要的朋友可以了解下。
2017-10-10
Java合并两个及以上有序链表的示例详解
这篇文章主要通过两个例题为大家介绍一下Java合并两个及以上有序链表的实现方法，文中的示例代码讲解详细，具有一定的学习价值，需要的可以参考一下
2022-11-11
使用Criteria进行分组求和、排序、模糊查询的实例
这篇文章主要介绍了使用Criteria进行分组求和、排序、模糊查询的实例，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-03-03
IDEA Java win10环境配置的图文教程
这篇文章主要介绍了IDEA Java win10环境配置,本文通过图文并茂的形式给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2020-07-07
微服务eureka和nacos案例详解
这篇文章主要介绍了微服务eureka和nacos,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2023-06-06
struts2中simple主题下<s:fieldError>标签默认样式的移除方法
这篇文章主要给大家介绍了关于struts2中simple主题下<s:fieldError>标签默认样式的移除方法，文中通过示例代码介绍的非常详细，需要的朋友可以参考借鉴，下面随着小编来一起学习学习吧
2018-10-10