IntelliJ IDEA 自定义方法注释

我们希望,在 IDEA 中给方法加注释说明可以像在 Eclipse 中一样,输入 /** 按回车自动生成一些注释。这需要用到 IDEA 的 Live Templates。

找到:Settings→Editor→Live Templates

  1. 点击 + 号,新增一个模板

  2. 在 Abbreviation 栏中填入:**

  3. 在 Description 栏中填写模板的描述,如:方法注释模板

  4. Template text 栏填入如下文本:

    1
    2
    3
    4
    5
    **
    * $description$
    * @author $user$ $date$$params$
    * @return $returns$
    */
  5. 打开 Edit variables 对话框,配置变量含义:

    默认的参数是按数组的方式显示的,为了像 Eclipse 一样,每个参数一行。我们需要为 params 变量设置 Default value 如下:

    1
    groovyScript("def result =''; def params = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) { if(params[i] =='') continue; result += ('\\n * @param' + params[i]) }; return result", methodParameters())
  6. 最后,在右下角 Expand with 选择:Enter,表示回车触发;再勾上:Reformart according to style 让 IDEA 格式化注释。