IDEA自定义liveTemplates(方法模板、类模板)

IDEA自定义liveTemplates(方法模板、类模板)

前言，搞这个模板有何意义？ 降低大家写方法注释的成本，统一风格。有时候不是开发同学不爱写注释，而是没有合适的载体和空间。

IDEA模板设置入口

模板设置入口： Preferences | Editor | Live Templates

一、方法注释快速生成设置

第一步

点击➕号，增加模板，并设置快捷键为’ff’，作用域为Java文件

模板内容

/**
 * $description$
 $params$
 * @return {@link $retrun$}
 * @author $author$
 * @date $date$
 *
 */

第二步 配置变量

点击EDIT VARIABLES有弹框
对几个$$的变量进行配置，如$description$

其中params特别注意，要配置groovy脚本，才能自动识别方法参数，如下

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

第三步 使用

随意点击某个方法

例如

    public String main(String[] args, String aaa) {
        在此处键入ff后，按tab键，即可生成模板注释，将模板注释复制到方法上，格式化即可
        return "";
    }

结果

    /**
     * main
     *
     * @param args description
     * @param aaa  description
     * @return {@link String}
     * @author starkhu
     * @date 2021/6/23
     */
    public String main(String[] args, String aaa) {

        return "";
    }

其他常用模板

todo的模板，带有生成todo的责任人和时间

// TODO: (所属人:$author$ $date$ $time$) description