解决idea添加方法注释时，@Param为null的问题，以及无返回值时显示@Return的问题

前言：

本文旨在解决idea添加方法注释时，@Param为null的问题，以及无返回值时显示@Return的问题

我自己也在网上查过很多资料，雷同的太多，实在坑太多，无奈写下这篇。

提醒：本文图文较多，流量党慎入！！！

预先配置模板组

---

步骤如下：

File

->Settings

->Editor

->Live Templates

->点击右侧"+"号

->点击模板组（Templatee Group），如下组图

                       

->新增模板组名（我的定义为MethodTemplateGroup）

                                                                   

配置具体的动态模板

选中新增的模板组，新增动态模板

                                                 

->按照如下图配置自己的模板

                                          

• 具体的模板内容如下

*
 * @Description:
$param$ $return$
 * @Author: （填写你自己的用户名）
 * @Date: $date$ $time$
 */

• 其他配置

Abbreviation(缩略字配置) :*
ExpandWith（扩展触发键）:选择Enter（回车）一定要！！！否则可能无法正常扩展
模板名：MethodLiveTemplate(自定义就好)

注：以上配置要严格按照该模板，否则最终效果会有偏差。

要注意的点

1. 模板缩略词为"*"仅有一个
2. 模板内容第一行第一个*号不缩进
3. $param$ $return$不缩进且为同一行
4. ExpandWith（扩展触发键）:选择Enter（回车）

->定义模板中的变量

          

• param配置 

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) ? '\\r\\n' : '')}; return result", methodParameters());

• return 配置

groovyScript("if(\"${_1}\" == 'void'){def result = ''} else { def returnType = \"${_1}\"; def result = '\\r\\n * @return: ' + returnType; return result;}", methodReturnType());

点击OK

配置该模板并测试

选择将模板应用于java - Comment，配置如下图：

                                                       

->任意新建测试类，新建测试方法，使用 /** +Enter键即可自动补全注释 我的测试案例如下，仅供参考

测试代码如下

package util.test;

import java.math.BigDecimal;

/**
 * ______   __   ___      __      ___  ___
 * /    " \ |/"| /  ")    /""\    |"  \/"  |
 * // ____  \(: |/   /    /    \    \   \  /
 * /  /    ) :)    __/    /' /\  \    \\  \/
 * (: (____/ //(// _  \   //  __'  \   /   /
 * \        / |: | \  \ /   /  \\  \ /   /
 * \"_____/  (__|  \__|___/    \___)___/
 * Simple to Introduction
 *
 * @projectName:develop-project
 * @packageName:util.test
 * @className:TestBigDeciaml
 * @Description:[测试BigDeciaml ]
 * @Author:wangzhen
 * @CreateDate:2021/5/13 15:21
 * @blog:[方法具体上行/下行参数文档]
 */
public class TestBigDeciaml {

   
   /**
    * @Description:
    * @param args 
    * @Author: wangzhen
    * @Date: 2021/5/14 10:39
    */
    public static void main(String[] args) {
        BigDecimal tBd = new BigDecimal("100.012");
        System.out.println(tBd.scale());
        System.out.println(tBd.unscaledValue());
    }


   /**
    * @Description:
    * @param txt 
    * @return: java.lang.String
    * @Author: wangzhen
    * @Date: 2021/5/14 11:39
    */
    public String getTxt(String txt){
        System.out.println(txt);
        return txt;
    }

   /**
    * @Description:
    * @param txt 
    * @Author: wangzhen
    * @Date: 2021/5/14 11:48
    */
    public void printTxt(String txt){
        System.out.println(txt);
    }

   /**
    * @Description:
    * @param txt
    * @param tline
    * @param tLineTxt 
    * @Author: wangzhen
    * @Date: 2021/5/14 11:43
    */
    public void getRsStr(String txt,String tline,String tLineTxt){
        System.out.println(tline);
    }
    
    /**
     * @Description:
     * @param txt
     * @param info
     * @param content 
     * @return: java.lang.String
     * @Author: wangzhen
     * @Date: 2021/5/14 11:46
     */
    public String getSumInfo(String txt,String info,String content){
        return txt+info+content;
    }

}