idea注释模版配置

原创已于 2025-08-12 16:37:32 修改 · 477 阅读

9 ·

本内容遵循CC 4.0 BY-SA版权协议

GEO检测

于 2025-08-12 16:36:50 首次发布

1.自动生成

可以通过添加类时自动生成注释，这里的名字也可以使用${USER}当前用户的用户名，如果需要设置接口和枚举的注释模版，只需要选择Interface和Enum复制一份就行

/**
 * @description: TODO 
 * @author wise
 * @date ${DATE} ${TIME}
 * @version 1.0
 */

然后去新建一个ServeController，可以看到类的注释已经自动生成了

2.自定义模版配置

除了自动生成还可以通过自定义模板的形式实现，首先在settings里找到Editor设置下的Live Templates下面的设置，然后点击＋号，选中Live Templates

应用范围选择Java

然后配置Template Text里面用$修饰的属性

方法注释模板

/** 
 * @description: $description$ 
 * @param: $params$ 
 * @return: $returns$ 
 * @author wise
 * @date: $date$ $time$
 */

类注释模板

/**
 * @author wise
 * @version 1.0
 * @description: TODO
 * @date $date$ $time$
*/

下面是params的默认值，其他的如图

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='' + params[i] + ((i < params.size() - 1) ? '\\n':'')}; return result", methodParameters())

配置完毕后发现类的注释是没问题的

但是方法的光标要在方法里才能拿到入参跟出参，接口实现的方法才能方法名上直接拿到，这个怎么解决？复制粘贴一下还是直接用/** + Enter🙃

标签

#intellij-idea #java