IDEA中设置类或方法的注释模板

wsdhla

已于 2024-03-04 10:01:32 修改

阅读量3.4k

点赞数 3

分类专栏： # Java 文章标签： idea 模板 Live Templates Templates code

于 2021-09-16 11:35:27 首次发布

本文链接：https://blog.youkuaiyun.com/wsdhla/article/details/120324664

版权

Java 专栏收录该内容

27 篇文章

订阅专栏

本文介绍了如何使用GroovyScript创建自定义的Live Templates，包括类注释、方法注释、参数描述和文件头模板。通过动态获取信息，简化了代码注释的编写过程，提升开发效率。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

定义Live Templates模板

1、类注释模板

/**
 * @ClassName: $className$
 * @Description: 类描述
 * @author: xxx
 * @date: $DATE$ $TIME$
 */

编辑模板变量：

2、方法注释模板

方法模板需要动态获取方法的参数及返回类型，可以借助groovyScript

**
 * @Title: $methodName$
 * @Description: 方法描述
 $params$
 * @return: $returnType$
 */

编辑模板变量：

params变量groovyScript脚本：

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

使用的时候也得注意："/" + 模板Abbreviation + tab

其他脚本示例：

// 输出package

groovyScript("def currentPackage = \"${_1}\"; def result = ' * @Package : ' + currentPackage + '\\n'; return result;", currentPackage())

// 输出class

groovyScript("def className = \"${_1}\"; def result = ' * @Class : ' + className + '\\n'; return result;", className())

================================================

 * @throws: $exception$

方法抛出异常注释没有解决，希望有搞出来的大神给补充一下

文件头模板

模板内容：

/**
 * 文件名： ${NAME}.java
 * 版权： Copyright 2020-2023 xxx All Rights Reserved.
 * 描述： XXX XXX
 */

如下图所示：

注意：这样默认的效果是文件头注释会放到package之后，如果想放到package之前，还需要做如下设置

文件模板也可以在Live Templates中定义，如下图：