IDEA 类和方法的模板注释设置

IDEA注释模板配置

最新推荐文章于 2023-07-11 16:13:36 发布

原创最新推荐文章于 2023-07-11 16:13:36 发布 · 274 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#IDEA #类模板注释 #方法模板注释

IDEA 专栏收录该内容

2 篇文章

订阅专栏

本文详细介绍如何在IntelliJ IDEA中配置类和方法的注释模板，包括自定义注释样式、日期格式及参数说明等内容，帮助提高开发效率。

1 类注释模板的设置

（1）File -------- Settings ------------ File and Code Templates
（2）在这里插入图片描述
如上图，选择 Class 选项，在 public class ${NAME} 这一行的上一行设置自己的模板。内容如下，可以根据自己的风格进行修改。

/**
     * description: ${description}
     * @author 张三
 	 * @date ${YEAR}-${MONTH}-${DAY} ${TIME}:${SECOND}
 	 * @version 
 	*/

在这里，我们使用${description}的方式的话，当我们新建一个类时会自动弹出一个编辑框输入类的说明（decription），当然你也可以直接写成文本。点击 Apply 和 OK

2 方法注释模板的设置

（1）File --------- Settings -------- Live Templates
（2）
在这里插入图片描述
新建自己的模板组名，名字根据自己的喜好自由填写即可。

（3）
在这里插入图片描述

Abbreviation 是后续我们在写代码时的快捷方式，比如我输入的是 add ,那么我们在写代码时，在类方法的上一行输入 /* + add + 回车 就会自动生成方法注释。前提是我把快捷的一个选项设置为了Enter , 默认是 Tab键 。你可以根据自己的喜好选择，如下图：
在这里插入图片描述
Template Text 是我们要生成的内容，以下内容可以作为参考，也可自行修改。

/**
	 * description:<方法说明>
     * @author 张三
	 * @date $date$ $time$
	 $params$
	 * @return $return$
	 */

（4）
在这里插入图片描述
以下是各个表达式，也可以根据自己的习惯自定义格式。

date： date("yyyy-MM-dd")；
time： time("HH:mm:ss")。
params：groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\n ' : '')}; return result", methodParameters())
returns：methodReturnType()

（5）
在这里插入图片描述
勾选 JAVA ，最后点击 Apply 和 OK ，我们就可以快捷生成类和方法注释了。你学会了吗，IDEA 小白根据前辈的经验自己写的第一篇文章，记录成长，加油！！！