IDEA为方法添加Javadoc风格的注释文档

  1. File-->Settings-->Editor-->Live Templates新建模板

  2. 定义触发模板的快捷键
    image-20220815202308739

  3. 模板内容

      /**
       * $END$
       * @author weixia
       * @date $date$$param$$return$
       */
    

    $param$$return$$date$写到一行是为了方便参数为空时解析结果

  4. 定义模板中所有变量的值

    IDEA默认提供的methodParameters()methodReturnType()函数默认生成的风格如下所示
    @param [param1,param2,...,param]
    所有入参集中在一行,不符和javadoc风格,要使用groovy脚本来自定义实现方法

    $param$变量:

    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())
    

    $return$变量:

    groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())
    

    image-20220815203013689

  5. 选择模板要适用的语言,勾选reformat according to style,点击apply和ok生效

posted @   未夏  阅读(173)  评论(0编辑  收藏  举报
相关博文:
阅读排行:
· TypeScript + Deepseek 打造卜卦网站:技术与玄学的结合
· 阿里巴巴 QwQ-32B真的超越了 DeepSeek R-1吗?
· 【译】Visual Studio 中新的强大生产力特性
· 10年+ .NET Coder 心语 ── 封装的思维:从隐藏、稳定开始理解其本质意义
· 【设计模式】告别冗长if-else语句:使用策略模式优化代码结构
历史上的今天:
2018-08-15 Cygwin编译java乱码
more_horiz
keyboard_arrow_up dark_mode palette
选择主题
点击右上角即可分享
微信分享提示