一、添加作者注释
1. 类头注释
打开file -> setting -> Editor -> File and Code Templates -> Includes -> File Header
这个是新建类的时候自动在类名上面添加的
/**
* @description:
* @author ${USER}
* @date ${DATE}
*/
2. Live Templates
打开file->setting->Editor->LiveTemplates
点击绿色的+号,新建一个Templates Group
,命名为HotKey
。
然后选中HotKey
,点击右边绿色的+号,新建一个Live Template
,命名为*
,描述为add header
。添加下列代码到Template text
中:
*
* @description:
* @author: $user$
* @date: $date$ $time$
* @param: $param$
* @return: $return$
*/
点击下方蓝色的define
按钮,会出现一个长框,选择Everywhere
就可以了,如下图所示:
选择Everywhere
之后,点击Edit variables
按钮,对Template text
里面的参数进行配置,如图所示:
点击OK,然后修改Expand with
选项,将值改为Enter
,意思是使用回车键来处罚模板事件
点击apply
和确定
按钮退出。(一定要按照文档的说明顺序来)
执行/**
+回车
,即可在方法名前加上作者注释,最终效果展示:
这时候就有强迫症的同学想要将idea提示的灰色背景去掉,好,有办法:
鼠标点击灰色背景块,执行alt + enter -> add to … custom tags 即可解决。
上述的这种方式将参数写到了一行,不方便对变量进行说明,可以采用下面的这种方式:
*
* @description:
* @author: $user$
* @date: $date$
$param$
* @return: $return$
*/
点击Edit variables
,对param
的Expression
进行修改:
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='* @param: ' + params[i] + ((i < params.size() - 1) ? '\\n ' : '')}; return result", methodParameters())
这样设置的话,每个@param为单独一行,可以对每一个变量进行描述,比较方便。如图所示:
二、添加Logger命令行
在平时开发中,可能会用到日志打印,但是命令很长,但书写方式固定,这时候就可以用到自定义模板了。
打开file->setting->Editor->LiveTemplates,点击HotKey
,添加一个新的Live Template
,取名为loggerDefineStatic
,描述为get logger
,在Template text
中加入:
private static final Logger logger = LoggerFactory.getLogger($CLASS_NAME$.class);
点击Edit variables
按钮,对Template text
里面的参数进行配置,如图所示:
在java文件中,输入logger
+Tab
键组合,即可自动出现
private static final Logger logger = LoggerFactory.getLogger(testLiveTemplate.class);
是不是很方便呢?
更多精彩干货内容,请关注微信公众号