IDEA 创建类注释模板和方法注释模板

阅读数:186 评论数:0

跳转到新版页面

分类

应用软件

正文

一、设置idea中的类注释模板

1、File->Settings->Editor->File and Code Template->Files

选择Class、Interface、Enum等待，我们可以看到，在右侧区域中，在public class 上面，都有一行 #parse("File Header.java") 。

2、这里引入的File Header.java在哪里？在Files右侧，有一个Includes选项。在这里，我们可以定义各种的模板，在需要的地方去引入这个模板，这里已经在类文件中引入了File Header.java 模板，那我们就更改这个模板成为我们想设置成的样子。

3、常用配置说明

${PACKAGE_NAME} : 包路径
${NAME} : 文件名
${USER} ： 主机用户名
${DATE} ： 系统当前日期，格式为：yyyy/mm/dd
${TIME} ： 系统当前时间 格式为：HH:mm
${YEAR}：当前年
${MONTH}：当前月
${MONTH_NAME_SHORT} ： 月份名称简写；如：Jan, Feb, etc.
${MONTH_NAME_FULL} ： 月份名称全拼；如：January, February.
${DAY} ：当前天
${DAY_NAME_SHORT} ：星期简写；如：Mon, Tue, etc.
${DAY_NAME_FULL}：星期全写；如：Mon, Tue, etc.
${HOUR} ： 当前小时
${MINUTE} ：当前分钟
${PROJECT_NAME} ： 项目名称

二、定义方法注释模样

1、File->Settings->Editor->Live Templates

2、点击右侧的+号，添加一个Template Group，命名为customTemplates

3、在刚刚创建的methodTemplates下创建一个Live Template

4、输入方法注释模板样式，可变变量要用$变量名$来表示。若不设置成如些的变量名，则不可点击右侧的Edit Variables。

$param$

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())

$return$

groovyScript("def result=''; def data=\"${_1}\"; def stop=false; if(data==null || data=='null' || data=='' || data=='void' ) { stop=true; }; if(!stop) { result += '\\r\\n' + ' * @return: ' + data; }; return result;", methodReturnType())

5、下方，可以点击选择该模板应用的范围，可选Everywhere 表示任何位置都可添加该注释

6、options 中的 Expand with 可选择该模板配合使用的快捷键，如 Tab键，Space 空格键， Enter 回车键等等；

如在这里设置的模板关键词为 * ，配合使用快捷键为Tab键
则在方法中输入 * ，在按下Tab 键，即可按照模板生成注释。