IntelliJ IDEA 之注释模板配置

1、配置类注释模板

打开File –> Settings设置面板–>Editor–>Live Templates，

点击左侧+号，选择创建模板组，并输入新名称，如下图

选中模板组，点击左侧+号，创建模板，如下图

配置模板的快捷键、描述、模板内容，点击下方Define，选择Java，如下图

/**
 * @classname:
 * @description:
 * @author luopf $Date$
 */

配置变量属性值

点击左下角OK按钮

2、配置方法注释模板(需在方法内 `/*` )

选择自己新建的组名称,点击左侧+号，创建模板，如下图

配置模板的快捷键、描述、模板内容，点击下方Define，选择Java，如下图

/**
  * @Description
  * @Param  $param$
  * @return $return$
  * @author luopf $date$
  */

配置变量属性值

点击左下角OK按钮

配置方法注解遇到的问题（注意配置好，只能在方法内部使用快捷键生成，然后复制到方法上，不知道IDEA为何这样）

/**
 * 跳转到管理页面(采购计划变更审批)
 * @Param request
 * @Param reponse
 * @author luopf 2018/11/20
 */

如果想把 @param：每一个参数可以这样

Edit Template：

参数值要自己写的 1、第一种写法

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) ? '\\r\\n\\0\\0' : '')};
 return result", methodParameters())

2、第二种写法

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\\b\\0\\0' : '')};
return result", methodParameters())

把这个添加进去，但是还要注意一点：

3、配置方法注释模板(需在方法外 `/*`) 推荐使用

打开File –> Settings设置面板–>Editor–>Live Templates，

如配置方法注释模板2，选择创建模板，如图：

第二步在Abbreviation输入：* （此处可输入随意字符，比如mt,使用注释时需 /mt）
第三步在Template text输入： ``` **
$description$$params$
@return $returns$
@create $date$ $time$ */ ```
第四步点击Edit variables配置如下图：

在 params 的 Default value 中复制如下代码，其他配置如图即可(Expression可通过选择得到)

groovyScript(
	"
		def result = '';
		def params = \"${_1}\".replaceAll(
			'[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); 
		if (params.size() > 1) {
			result +='\\n * @param ' + params[0] + ' \\n';
			for(i = 1; i < params.size(); i++) {
				result += ' * @param ' + params[i] + 
					((i < params.size() - 1) ? ' \\n' : '');
			};
		}else if (params.size()==1) {
			if (params[0] != '') {
				result+='\\n * @param ' +params[0] + ' ';	
			}
		}else {
			result += params[0] + ' ';
		};
		return result
	",
	methodParameters()
	)

扫码加好友

（转载本站文章请注明作者和出处追梦er）

IntelliJ IDEA 之 注释模板配置