idea给方法生成doc注释，半智能化展示参数

idea给方法生成doc注释，半智能化展示参数，结果是这样的：

/**
 * @descpt 查询用户在立项|中期|结题各阶段的审核信息
 * -------------------------------description-----------------------------------
 * @param xmbh：项目编号
 * @param id：主键ID
 * @param sbbh：申报编号
 * @param jdbh：阶段编号
 * @return java.lang.String
 * --------------------------------parameter------------------------------------
 * @author xiaotiantian
 * @date 2021-1-30 10:28
 * -------------------------------designerInfo----------------------------------
 */


/**
 * @descpt 设置个人的出生地为指定格式
 * @param ryxxObj：人员信息实体类
 * ＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿
 * @author xiaotiantian
 * @date 2021-6-30 0030 9:02
 */

步骤1，基本的设置

步骤2：粘贴上模板内容

尽量不要修改样式，这都是安排好的

**
* @descpt  TODO
* -------------------------------description-----------------------------------$param$
* @return  $returns$
* --------------------------------parameter------------------------------------
* @author  xiaotiantian
* @date    $date$ $time$
* -------------------------------designerInfo----------------------------------
*/

//也可以这样：
**
 * @descpt TODO$param$
 * ＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿
 * @author xiaotiantian
 * @date $date$ $time$
 */

步骤3：编辑自己写的带有 “$ $” 属性名的变量

return：

methodReturnType()

time：

 time()

date：

• 默认的时间格式是：2021/1/30 00:22
  看着好别扭啊，我喜欢看横杠的这种：2021-01-30 00:23
• 所以你需要下面这段代码，将这段代码直接粘贴过去就可以。

groovyScript("
    def result='';
    def params=\"${_1}\".replaceAll('/', '-');
    return params",date()
)

params：

• 把下面的这些代码直接粘贴过去。
• 这里我把动态读取出方法参数的地方做了些调整，常见的方法参数我直接不生成了，因为有些变量，即使生成了你也不可能会去一个个写注释。

groovyScript("
    def result='\\n';
    def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();
    for(i = 0; i < params.size(); i++) {
        if(params[i]!=null &&params[i]
            &&params[i].indexOf('request')<0
            &&params[i].indexOf('session')<0
            &&params[i].indexOf('response')<0
            &&params[i].indexOf('page')<0
            &&params[i].indexOf('Page')<0
            &&params[i].indexOf('user')<0
            &&params[i].indexOf('entity')<0
            &&params[i].indexOf('model')<0){
            result+=' * @param ' + params[i] + '：' + ((i < params.size() - 1) ? '\\n' : '')
        }
    };
    return result",methodParameters()
)

使用方式：

在方法的上面输入： /*
然后按键盘的 Tab 按键
这时自动生成注释
案例如下：

/**
 * @descpt 查询用户在立项|中期|结题各阶段的审核信息
 * -------------------------------description-----------------------------------
 * @param xmbh：项目编号
 * @param id：主键ID
 * @param sbbh：申报编号
 * @param jdbh：阶段编号
 * @return java.lang.String
 * --------------------------------parameter------------------------------------
 * @author xiaotiantian
 * @date 2021-1-30 0030 10:28
 * --------------------------------designerInfo---------------------------------
 */


/**
 * @descpt 设置个人的出生地为指定格式
 * @param ryxxObj：人员信息实体类
 * ＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿
 * @author xiaotiantian
 * @date 2021-6-30 0030 9:02
 */