IDEA使用模板自动生成类注释和方法，解决方法注释在接口中或普通类的方法外使用模板注释不带参数的情况

大家好，又见面了，我是你们的朋友全栈君。如果您正在找激活码,请点击查看最新教程,关注关注公众号 “全栈程序员社区” 获取激活教程,可能之前旧版本教程已经失效.最新Idea2022.1教程亲测有效,一键激活。

Jetbrains全系列IDE使用 1年只要46元 售后保障 童叟无欺

类注释

按照下方路径打开设置

File->Settings->Editor->File and Code Templates->Includes->File Header

File Header代码

/**
 * @author       ${USER}
 * @date         Created in ${DATE} ${TIME}
 * @modified By  ${USER} in ${DATE} ${TIME}
 * @description  AddDescriptionHere
 */

idea 模板使用的velocity模板语言，

velocity.apache.org

方法注释

File->Settings->Editor->Live Templates

1.创建模板组

2.创建对应模板

3.修改快捷键（缩略词）

• 针对在接口中或普通类的方法外使用模板注释不带参数的情况

假如触发的快捷键为doc,
★在类中输入 "/doc" 触发方法注释可以带参数，
★但是下方的template text 开头要去掉"/"<br>

为了符合注释习惯，可以将快捷键设为 * 或 **,
★在类中输入 /*或者/**可以触发带参数的方法注释
★对应的，在template text 开头要去掉 /或者/*

• 相当于将快捷键替换为template text中的内容,很好理解

4.添加模板内容

**
 * $insert$ AddDescriptionHere
 * @author  $user$ 
 * @date    $date$ $time$
 * @param   $param$
 * @return  $return$
 */

5.添加关联文件(可以是Java，也可以全选)
6.编辑模板变量

• param的脚本
• return 也可以这样的脚本设置

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

7.应用保存

参考：
idea 自动生成类注释和方法注释的实现步骤-脚本之家
使用groovy脚本生成idea方法注释参数格式对齐