idea设置java类和方法的注释模板

最新推荐文章于 2025-09-24 01:18:53 发布

原创最新推荐文章于 2025-09-24 01:18:53 发布 · 796 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#idea #注释模板 #java #类和方法

java 同时被 2 个专栏收录

10 篇文章

订阅专栏

idea

1 篇文章

订阅专栏

本文详细介绍如何在IDEA中配置Java类和方法的注释模板，包括设置作者、日期等信息，以及如何通过LiveTemplates自定义注释样式。

idea设置java类上的注释模板

idea打开配置路径：File>Settings>File>Editor>File and Code Templates>Files
依次选中Class、Interface、Enum、AnnotationType
在右侧框中填上如下注释模板：

/**
 * 
 * @author 刘江平
 * @date ${DATE} ${TIME}
 */

看图说话

在这里插入图片描述

idea设置java方法的注释模板

idea打开配置路径：File>Settings>File>Editor>Live Templates
1.新建Template Group：JavaMethod (名称自定义)
在这里插入图片描述
2.在模板组JavaMethod下新建Live Template：

3.Abbreviation设置为 * ;
4.Template text填如下注释代码：

*
 * 
 * @author 刘江平
 * @date $date$ $time$ $param$ $return$
 **/

5.点击Edit variables,$参数配置如下：

date：date()

time：time()

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

return：groovyScript("def result=''; def returnType=\"${_1}\"; if('void'!=returnType && returnType!='null'){result+='\\n * @return ' + returnType}; return result", methodReturnType())

@throws 没法配置，没有对应的获取方法
6.点击模板框下方的Define，设置模板应用范围为java，勾选Java
在这里插入图片描述

7.设置使用注释模板的快捷方式
鼠标点击模板组JavaMethod,然后在最上方By default expand with处选择enter

8.在方法上通过输入/**,再回车就可以使用这个模板了