IntelliJ IDEA技巧-添加类注释和方法注释

Posted on | In |

添加文件头注释

打开设置：
Editor->Filr and Code Templates->Includes->File Header

设置头注释

这个注释只是你在生成类文件时在类上方的注释
右下角是idea中模板中支持的变量

我的注释模板 :

1
2
3
4
5
6
7
8
/**
* @program: ${PROJECT_NAME}
* @Package ${PACKAGE_NAME}
* @Description: TODO
* @author Miss.Ning
* @date ${DATE} ${TIME}
* @version V1.0
*/

添加方法注释

Editor->Live Templates
可以自己新建一个自己的注释模板

新建模板组

右上角+号，选择Template Group，建一个属于自己的模板组，我的名字是MyComment
模板组可以方许多你自己新建的模板

新建注释模板组

新建模板

选中刚刚新建的组（我的是MyComment），点击右上角+号，选择Live Template

新建注释模板

  1. Abbreviation：这里可以起一个名字，相当于生成注释的提示，可以是一个符号，或是一个字母
  2. description：描述，可写可不写
  3. Template：放你的模板
  4. 点击define，选择EveryWhere
  5. 点击右边的Edit variables
  6. 右边的Expand可以选择你生成注释的快捷键，默认tab键

生成注释：你设置的Abbreviation快捷键 + Expand设置的快捷键

填写基本设置

新建方法模板

define

在Edit variables中，设置你在注释模板中的参数：

变量设置

自定义注释参数显示

但是idea中的param参数显示的是一个数组

1
2
3
4
5
6
7
8
9
/**
* @param [param1,param2...]
* @Description: 测试生成方法注释的参数
* @author Miss.Ning
* @date 2018/04/28 15:50
*/
public void methodTest(int param1, String param2...) {
    ...
}

可以用groovyScript脚本写一个生成参数，将多个参数分行显示
如果采用以上的自定义参数模板，那么注释模板也要改变

自定义param

将以下内容写到param的expression中即可：

1
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + '\\t' + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())
生成注释方式以及注释模板

Abbreviation是你生成注释打的一个提示，如果你写的是a，那么你在写注释时只用打一个a，按tab键即可生成

1.普通模板（在你的参数设置使用系统自带的返回参数方法时可用），生成方式：你设置的Abbreviation + tab键

1
2
3
4
5
6
7
/** 
 * @Description: $description$ 
 * @Param: $params$ 
 * @return: $returns$ 
 * @Author: Miss.Ning 
 * @Date: $date$ $time$ 
 */

2.设置我在上面提供的自定义参数，生成方式：你设置的Abbreviation + tab键

1
2
3
4
5
6
7
/** 
 * @Description: $description$ 
$params$ 
 * @return: $returns$ 
 * @Author: Miss.Ning
 * @Date: $date$ $time$ 
 */

3.我的习惯设置 生成方式：/* + tab键

我的模板比较特殊，因为我在生成方法注释时习惯先打/*出现注释，所以我将Abbreviation设为，然后生成注释时先打一个/\，按一下tab快捷键，就生成注释了

以下是我的注释模板，注意前后空格哦 （注意哈，我的模板开头少了/*，因为我在生成注释时已经打了一个/*了） 

1
2
3
4
5
6
7
* 
 * @Description: $description$ 
$params$ 
 * @return: $returns$ 
 * @Author: Miss.Ning 
 * @Date: $date$ $time$ 
 */

以下就是我生成的注释，在方法上输入：/* + tab键生成

1
2
3
4
5
6
7
8
9
10
11
/**
* @Description: 测试生成方法注释的参数
* @param: param1
* @param: param2
* @return:
* @Author: Miss.Ning
* @Date: 2018/04/28 15:50
*/
public void methodTest(int param1, String param2...) {
    ...
}