1、设置文件注释
设置Java类的注释模板,创建Java类自动生成该注释模板。
先看文件注释效果:
1.1、选择 IntelliJ IDEA
—> 选择 Preferences...
打开IDEA属性设置面板
1.2、选择 File Code Templates
—>选择 Includes
选项卡—>选择 File Header
,添加注释模板,点击 Apply
和 OK
按钮生效模板配置。
类文件注释模板:
/**
*
* @description:
*
* @author: ${USER}
* @time: ${DATE} ${TIME}
*
*/
2、设置方法注释模板
需要实现的方法注释效果,在方法顶上输入/**
+ Enter
即可以给方法添加我们自定义的方法注释。
2.1、打开IDEA属性设置面板
选择 IntelliJ IDEA
—> 选择 Preferences...
2.2、添加 Template Group
2.2.1、选择 Live Tempates
—> 选择 Template Group...
,打开添加模板组面板。
2.2.2、填写模板组名称 MyCodeGroup
,名称可以自己自定义。
2.2.3、选择 Live Template
,选中我们刚刚创建的MyCodeGroup
,选择Live Template
,给我们刚刚创建的模板组添加自定义动态模板。
2.2.4、填写模板信息
选中我们刚刚添加的Live Tempate,填写相关信息。
添加快捷键与注释
Abbreviation
关键字
Description
模板说明
模板信息内容:
*
* description: $description$ <br>
* date: $date$ $time$ <br>
* author: $user$ <br>
*
$params$
* @return $return$
*/
注意上述文字一定要一个字不差的填写, 我的模板并没有写歪, 而是必须要这么写才能正常使用, 关键字需要用
*
, 不要改动。
2.2.5、给模板注释添加动态函数值
选择 Edit variables
, 填写相关信息,填写完,点OK
完成。
依次对应的函数值:
methodName()
date()
time()
user()
groovyScript("def result=''; def stop=false; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); if (params.size()==1 && (params[0]==null || params[0]=='null' || params[0]=='')) { stop=true; }; if(!stop) { for(i=0; i < params.size(); i++) {result +=((i==0) ? '\\r\\n' : '') + ((i < params.size() - 1) ? ' * @param: ' + params[i] + '\\r\\n' : ' * @param: ' + params[i] + '')}; }; return result;", methodParameters())
methodReturnType()
$date$
$time$
$params$
$return$
这些用$
符号包括的代码 这些都是自定义变量, 而我想在写注释的时候实时获取这些, 比如时间, 日期, 参数名, 返回值类型 所以需要关联编译器的变量自动填入。
2.2.6、设置模板应用的语言为 java
2.2.7、设置展开的快捷键,默认是 Tab
键
习惯可以设置为回车键 Enter
。
至此设置完成,在方法名输入 /**
+ Enter
即可以显示出相关注释。
3、设置类注释模板
IDEA 是没有像Eclipse方便的类注释,需要自己添加。比如在类文件 头部输入
cls
+Enter
快捷键对应开头的文件注释
。
3.1、选择 Live Template
,选中我们刚刚创建的MyCodeGroup
,选择Live Template
,给我们刚刚创建的模板组添加自定义动态模板。
3.2、填写模板信息
选中我们刚刚添加的Live Tempate,填写相关信息。
添加快捷键与注释
Abbreviation
关键字
Description
模板说明
模板信息内容:
/**
* @description: $CLASS_NAME$
* @author: $USER$
* @time: $DATE$ $TIME$
*/
注意上述文字一定要一个字不差的填写, 不要改动。
3.3、给模板注释添加动态函数值
选择 Edit variables
, 填写相关信息,填写完,点OK
完成。
依次对应的函数值:
className()
user()
date()
time()
CLASS_NAME
USER
$DATE$
$TIME$
这些用$
符号包括的代码 这些都是自定义变量, 而我想在写注释的时候实时获取这些, 比如时间, 日期,所以需要关联编译器的变量自动填入。
3.4、设置模板应用的语言为 java
3.5、设置展开的快捷键,默认是 Tab
键
习惯可以设置为回车键 Enter
。
至此设置完成,在方法名输入 cls
+ Enter
即可以显示出相关注释。