本文主要记录了在编程过程中注释的一些快捷键配置,为了以后便于配置,特此记录,仅供参考。
本文适用于想配置idea
但是又不知道如何配置的新手小白。文章主要有以下内容:
idea
方法模板注释- 属性注释
- 文件头注释
方法注释
打开Idea
,再打开设置面板的【setting】--->【Live Template】点击 +
新建一个Template Group
,我这里取名是UserDefine
。
选中刚刚创建的Template Group
,点击刚刚的+
;
新建一个Live Template
,依次在输入框输入如下信息。
- 在
Abbreviation
输入**
, - 在
Description
中添加该操作的注释,我这里写的是方法注释。 - 在右下方的
Options
中将Expand with
修改为Enter
- 在模板内容框中输入如下内容:
java
**
* 功能:
*
* @author Java
* @date $date$ $time$
$param$$return$*/
如下图所示:
点击Edit Variables
按钮,给我们的变量赋值:
param
参数取值如下:
java
groovyScript("def result = '';def params = "${_1}".replaceAll('[\\[|\\]|\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='* @param ' + params[i] + ' ' +((i < params.size() - 1) ? '\r\n ' : '\r\n ')}; return result == '' ? null : result", methodParameters())
return
取值如下:
java
groovyScript("def returnType = "${_1}"; def result ='';if(returnType=='null'||returnType=='void'){return;}else{result += '* @return ';cls = returnType.split('<');for(i = 0; i < cls.size(); i++){temp = cls[i].tokenize('.');result += temp[temp.size() - 1] + ((i < cls.size() - 1) ? '<' : '');};return result + ' \r\n ';}", methodReturnType());
点击change
,选中Java
,如下图所示:
设置完上述设置之后,点击Apply
在点击ok
就可以在idea
中使用了只需要/**
+Enter
键即可。如下图所示
属性注释
属性注释的配置比方法配置更加简单只需要按照下图的配置即可:
按照相同的方式添加一个Live Template
,依次输入各个模块的信息,最后点击change
,选中Java
即可。
此时通过f
+Tab
组合键就可以形成注释模板,在其中输入字段注释即可,如下图:
文件注释
注释模板如下所示
java
/**
* @author: Java
* 创建时间: ${YEAR}年${MONTH}月${DAY}日 ${HOUR}:${MINUTE}
* 文件描述: ${Description}
*/
Class、枚举、接口文件
都可以使用上述模板,按照下图配置即可。