intellij idea设置统一JavaDoc模板的方法详解

更新时间：2021年04月03日 08:42:17 作者：Amir_wu

这篇文章主要介绍了intellij idea设置统一JavaDoc模板的方法详解,本文通过图文并茂的形式给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下

idea设置统一JavaDoc模板

设置普通注释

按照如下导航找到位置：

Setting > Editor > File and Code Templates > Includes > File Header

复制如下，即可实现简单的JavaDoc注释

/**
 * @author : ChenLiWu
 * @date : ${DATE} ${TIME}
 */

简单的注释

自定义模板

方法注释

按照如下导航找到位置：

Setting > Editor > Live Templates

看到右边的 + 按钮，选择第二项 2. Template Group… Group 名字随便定义

增加好 Group 之后，点击选中自己添加的 Group，再点击右边的**+**选择第一项 1. Live Template

按照下图设置，

**
 * description: $description$
$params$
 * @return $return$
 * @throws $throws$
 * @author ChenLiwu
 * @date $date$ $time$
 */

在这里插入图片描述

其中params对应的是用脚本写的：

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

在这里插入图片描述

类名注释

同理：

**
 * description: $description$
 * @author ChenLiwu
 * @version 1.0
 * @date $date$ $time$
 */

在这里插入图片描述

这样一来“/” + 你的快捷触发键 + 快捷生成按钮即可一键生成你要的javadoc模板注释

到此这篇关于intellij idea设置统一JavaDoc模板的文章就介绍到这了,更多相关idea JavaDoc模板内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

dubbo如何实现consumer从多个group中调用指定group的provider
这篇文章主要介绍了dubbo如何实现consumer从多个group中调用指定group的provider问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-03-03
浅谈Java中ThreadLocal内存泄露的原因及处理方式
内存泄漏就是我们申请了内存，但是该内存一直无法释放，就会导致内存溢出问题，本文详细的介绍了ThreadLocal内存泄露的原因及处理方式，感兴趣的可以了解一下
2023-05-05
Java中四种引用详解
这篇文章主要为大家介绍了Java中的四种引用，具有一定的参考价值，感兴趣的小伙伴们可以参考一下，希望能够给你带来帮助
2021-12-12
Java 栈和队列的交互实现
栈和队列都是常用的数据结构,本文就来介绍一下Java 栈和队列的交互实现,主要包括队列模拟实现栈及栈模拟实现队列,具有一定的参考价值,感兴趣的可以了解一下
2023-12-12
很多人竟然不知道Java线程池的创建方式有7种
本文主要介绍了很多人竟然不知道Java线程池的创建方式有7种，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-07-07
SpringBoot项目调优及垃圾回收器的比较详解
这篇文章主要介绍了SpringBoot项目调优及垃圾回收器的比较详解，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-04-04
Java Integer如何获取第一位和最后一位,并截取
这篇文章主要介绍了Java Integer如何获取第一位和最后一位并截取，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-01-01
SpringMVC Json自定义序列化和反序列化的操作方法
这篇文章主要介绍了SpringMVC Json自定义序列化和反序列化的操作方法,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-01-01
java设计模式-装饰者模式详解
这篇文章主要介绍了Java设计模式之装饰者模式详解和代码实例,Decorator模式(别名Wrapper):动态将职责附加到对象上,若要扩展功能,装饰者提供了比继承更具弹性的代替方案,需要的朋友可以参考下
2021-07-07
SpringCloud集成AlloyDB的示例代码
AlloyDB 是 Google Cloud 提供的一种高度可扩展、强性能的关系型数据库服务,它兼容 PostgreSQL,并提供了更快的查询性能和更高的可用性,本文给大家介绍了如何使用SpringCloud集成AlloyDB,需要的朋友可以参考下
2025-01-01