类注释模板
1、File-->settings-->Editor-->File and Code Templates-->Files
我们选择Class文件(当然你要设置接口的还也可以选择Interface文件);
下面附上IDEA内置的一些变量的说明,根据自己的需求添加即可.
在文件模板中,您可以使用文本、代码、注释和预定义变量。 以下提供了预定义变量的列表。 当您在模板中使用这些变量时,它们稍后会在编辑器中扩展为相应的值。 您也可以指定自定义变量。 自定义变量使用以下格式:${VARIABLE_NAME},其中 VARIABLE_NAME是变量的名称(例如,${MY_CUSTOM_FUNCTION_NAME}) 。 在 IDE 创建包含自定义变量的新文件之前,您会看到一个对话框,您可以在其中定义模板中自定义变量的值。 通过使用 #parse 指令,可以包括 包含 选项卡中的模板。 要包含模板,请在引号中将模板的全名指定为形参(例如,#parse("File Header"))。
预定义变量列表
${DATE} 当前系统日期
${DAY} 当前月份的日期
${DAY_NAME_SHORT} 当前日期名称的前 3 个字母(例如,Mon、Tue 等)
${DAY_NAME_FULL} 当前日期的全名(Monday、Tuesday 等)
${DIR_PATH} 新文件的目录路径(相对于项目根目录)
${DS} 美元符号 ($)。 此变量用于转义美元字符,因此不会将其视为模板变量的前缀。
${FILE_NAME} 新文件名称
${HOUR} 当前小时
${MINUTE} 当前分钟
${SECOND} 当前秒
${MONTH} 当前月份
${MONTH_NAME_SHORT} 当前月份名称的前 3 个字母(Jan、Feb 等)。
${MONTH_NAME_FULL} 当前月份的全名(January、February 等)。
${NAME} 新实体的名称(文件、类型、接口等)
${ORGANIZATION_NAME} 在项目设置中指定的组织名称
${PRODUCT_NAME} IDE 名称
${PROJECT_NAME} 当前项目名称
${TIME} 当前系统时间
${USER} 当前用户的系统登录名
${YEAR} 当前年度
预定义变量列表
${DATE} 当前系统日期
${DAY} 当前月份的日期
${DAY_NAME_SHORT} 当前日期名称的前 3 个字母(例如,Mon、Tue 等)
${DAY_NAME_FULL} 当前日期的全名(Monday、Tuesday 等)
${DIR_PATH} 新文件的目录路径(相对于项目根目录)
${DS} 美元符号 ($)。 此变量用于转义美元字符,因此不会将其视为模板变量的前缀。
${FILE_NAME} 新文件名称
${HOUR} 当前小时
${MINUTE} 当前分钟
${SECOND} 当前秒
${MONTH} 当前月份
${MONTH_NAME_SHORT} 当前月份名称的前 3 个字母(Jan、Feb 等)。
${MONTH_NAME_FULL} 当前月份的全名(January、February 等)。
${NAME} 新实体的名称(文件、类型、接口等)
${ORGANIZATION_NAME} 在项目设置中指定的组织名称
${PRODUCT_NAME} IDE 名称
${PROJECT_NAME} 当前项目名称
${TIME} 当前系统时间
${USER} 当前用户的系统登录名
${YEAR} 当前年度
样式:
/**
* @ClassName ${NAME}.java
* @ProjectName ${PROJECT_NAME}
*/
效果:
/**
* @ClassName Test.java
* @ProjectName demo
*/
方法注释模板
1、创建模板
IDEA还没有智能到自动为我们创建方法注释,这就是要我们手动为方法添加注释,使用Eclipse时我们生成注释的习惯是/**+Enter
,这里我们也按照这种习惯来设置IDEA的方法注释;
1、File-->Settings-->Editor-->Live Templates
(1)新建组:命名为userDefine;
(2)新建模板:命名为*
;
因为IDEA生成注释的默认方式是:/*
+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为/*add+Tab
),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、获取方法返回值的methodReturnType()
2、设置模板内容-IDEA格式模板(JavaDoc格式)
注意第一行,只有一个*
而不是/*
,如果前面加了/
会获取不到参数.
在设置参数名时必须用${参数名}$的方式,否则第五步中读取不到你设置的参数名.
样式:
*
* @Description //TODO $param$ $return$
*/
3、设置参数
JavaDoc格式的需要自定义参数以及返回值的实现方式,分别填入param和return对应的默认值:
获取参数(param):
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 ' : '')}; return result == '' ? null : '\\r\\n ' + result", methodParameters())
获取返回值(return):
groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())
效果:
/**
* @Description 获取用户基本信息
* @param type
* @param idNumber
* @return UserBaseInfo
*/