idea 修改类注释及方法注释模板

IDEA代码注释自动生成

最新推荐文章于 2025-03-25 07:30:00 发布

原创最新推荐文章于 2025-03-25 07:30:00 发布 · 1.8k 阅读

1 ·

CC 4.0 BY-SA版权

本文介绍如何在IntelliJ IDEA中配置自动生成文件头注释和方法注释，通过设置Preferences和LiveTemplates，实现高效规范的代码注释生成。

生成类注释
打开Preferences
Editor -> File and Code Templates -> includes --->File Header
在这里插入图片描述
模板:

/**
* @ClassName ${NAME}.java
* @author liuhua
* @version 1.0.0
* @Description TODO
* @createTime ${YEAR}-${MONTH}-${DAY}- ${HOUR}:${MINUTE}:00
*/

二、定义方法注释模板
File -> Settings -> Editor -> Live Templates

在Live Templates 右侧点击+号，添加一个Templates Group，命名为 methodTemplates

在这里插入图片描述
模板:

*
* @Author liuhua
* @Description //TODO $end$
* @Date $date$ $time$ $param$ $return$
**/

在这里插入图片描述

**param :**

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 +=((i==0) ? '\\r\\n' : '') + ((i < params.size() - 1) ? ' * @param: ' + params[i] + '\\r\\n' : ' * @param: ' + params[i] + '')}; }; return result;", methodParameters())

**return :**

groovyScript("def result=''; def data=\"${_1}\"; def stop=false; if(data==null || data=='null' || data=='' || data=='void' ) { stop=true; }; if(!stop) { result += '\\r\\n' + ' * @return: ' + data; }; return result;", methodReturnType())
2）、在位置3下方，点击选择该模板应用的范围，可选Everywhere 表示任何位置都可添加该注释

在这里插入图片描述