idea自动生成注释

idea 自动生成注释

1 创建类时，自动生成注释

模板代码如下

/**
* @program: ${PROJECT_NAME}   
*
* @description: ${description}   
*
* @author: yun
*
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}     
**/

2 在方法上使用快捷键生成注释

先新建一个template group,我命名为mygroup,再在group新建live template

实现参数类似eclipse的效果，多个参数自动换行

     /**
     * @Description: TODO 描述方法主要功能
     *
     * @Param: pageNo
     * @Param: pageSize
     * @Param: filterTimestamp
     * @Return: java.util.List
     * @Author: yun
     * @Date: 2025/2/17 18:13
     */
    List listV2(Integer pageNo, Long filterTimestamp);

template text模板如下

 *
 * @Description: TODO 描述方法主要功能
 * $param$
 * @Return: $return$
 * @Author: yun
 * @Date: $date$ $time$
 */

注意这里需要左缩减一个空格

选择模板应用到java代码

edit variables进行模板参数编辑

如果param参数使用默认的methodParameters()来获取方法参数值，其注释参数是在一行展示的，如下图。这里我们希望像MyEclipse中一样，一行一个参数的样式，可以通过脚本来实现。将以下脚本复制进Expression，可以得到文章开头效果图的样式

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

3 效果

使用默认的拓展快捷键tab, /** + tab进行自动显示方法注释

如果

4 导入导出配置

5 参考链接

IDEA中设置注释模板_idea配置注释模板-CSDN博客