IDEA类注释模板和方法注释模板
前言
在我们的开发过程中。良好的代码习惯总是重要的(ps:编程两大痛苦:别人不写注释文档,自己写注释文档),而注释模板往往能帮我们省很多事。今给大家分享一下自己常用的模板和设置方法
一、设置IDEA 中的类注释模板
File -> Settings -> Editor -> File and Code Templates -> Files
中文版如下:
文件 -> 设置 -> 编辑器 ->文件和代码模板 -> 文件
选择Class , Interface ,Enum 等等,我们都可以看到,在右侧区域中,在public class 上面,都有一行 #parse(“File Header.java”) ,
这句代码是引入了File Header.java文件,作为我们创建的Class Interface ,Enum 等文件的注释,那么这个类在哪呢,我们可以看到,在 Files 右侧,有一个 Includes 选项,在这里,我们可以定义各种的模板,在需要的地方去引入这个模板,这里已经在类文件中引入了File Header.java 模板,那我们就更改这个模板成为我们想设置成的样子
模板如下
/**
*@BelongsProject: ${PROJECT_NAME}
*@BelongsPackage: ${PACKAGE_NAME}
* @Classname: ${NAME}
* @CreateTime: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
* @Created by: ${USER}
* @Description: ${description}
* @Version: ${version}
*/
其他扩展:
${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} : 项目名称
二、定义方法注释模板
File -> Settings -> Editor -> Live Templates
文件 -> 设置 -> 编辑器 -> 实时模板(中文版)
在实时模板 右侧点击+号,添加一个Templates Group,命名为 methodTemplates
添加一个模板组(Templates Group)
MyGroup
在刚刚创建的 模板组(methodTemplates) 下创建一个实时模板( Live Templates) ,如下
在位置1处: 输入模板的简写码
在位置2处:输入模板的描述
在位置3处: 输入方法注释模板样式,可变变量要用
变
量
名
变量名
变量名 来表示,如:
p
a
r
a
m
param
param;
若不设置成如此的变量名,位置4不可点击,模板如下:
*
* @methodName: $title$
* @description: $description$
* @Author $USER$
* @param $param$
* @updateTime $date$ $TIME$
* @return $return$
* @throws $throws$
*/
点击位置4处:可编辑定义的变量的值,如下:
变量param 为方法的参数变量,需要根据方法的参数多少进行变化;变量 return 为返回值类型,也要根据方法的返回值进行变化,所一要自行设置该方法,设置的代码如下,复制粘贴即可:
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())
在位置3下方,点击定义选择该模板应用的范围,可选Java 表示任何位置都可添加该注释
点击选项 中的 展开方式 可选择该模板配合使用的快捷键,如 Tab键,Space 空格键 , Enter 回车键 等等;
如在这里设置的模板关键词为 * ,配合使用快捷键为回车键
则在方法中输入 * ,在按下回车 键,即可按照模板生成注释。
每天一个小知识
有些小伙伴想知道我用的idea为什么是中文版的,是因为我用的是idea的汉化插件(博主比较爱国,哈哈)
1、文件 -> 设置 -> 插件 -> Marketplace->搜索框输入Chinese->选Chinese Language Pack
安装重启就行了!