idea中生成标准（不带警告）的方法注释

最新推荐文章于 2024-02-13 17:36:20 发布

昆虫520

最新推荐文章于 2024-02-13 17:36:20 发布

阅读量893

点赞数 2

文章标签： intellij idea

本文链接：https://blog.youkuaiyun.com/weixin_40427212/article/details/107945504

版权

本文介绍如何在IDEA中配置LiveTemplates，自动生成无错误提示的标准方法注释，包括自动识别参数和返回值，提高代码规范性和效率。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

网上一搜，几乎全都是一模一样的教程，并且都会有一些小瑕疵，比如 idea会提示 wrong tag错误信息，或者javadoc无法识别等等。经过我的摸索改进之后，会自动生成没有错误提示的标准的方法注释。自动识别参数，和返回值，若都为空则不展示

依次进入 File | Settings | Editor | Live Templates 选项卡，在 doc 选项下编辑

*
 * TODO
 *
 $params$$return$
 * @author kun
 * @date $date$ $time$
 */

点击旁边的 Edit variables 按钮

params 变量输入

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

return 变量输入

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

date变量输入 date()

time变量输入time()

之后点击确认应用即可

效果图：

    /**
     * 检查红包是否已领取过
     *
     * @param list    红包领取记录列表
     * @param unionId 微信用户unionid
     * @return boolean
     * @author kun
     * @date 2020/8/11 10:32
     */
    private boolean isCollected(List<NewRedPacket> list, String unionId) {
        //检查list中至少有一个元素满足条件，返回true，否则false
        return list.stream().anyMatch(red -> StringUtils.equals(unionId, red.getUnionId()));
    }