通过File and Code Templates设置模板
此方法
适用于文件创建时自动生成
,不支持快捷键生成。此处以生成java类模板
举例说明。
路径: File–>settings–>Editor–>File and Code Templates–>Files
选择class
添加模板:
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
* @ClassName: ${NAME}
* @Author: ${USER}
* @Date: ${DATE} ${TIME}
* @Description: TODO
*/
public class ${NAME} {
}
选择interface
添加模板:
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
* @ClassName: ${NAME}
* @Author: ${USER}
* @Date: ${DATE} ${TIME}
* @Description: TODO
*/
public interface ${NAME} {
}
通过Live Templates设置模板
此方法
适用于文件快捷键生成
,不支持创建时自动生成。此处以生成java方法模板
举例说明。
路径: File–>Settings–>Editor–>Live Templates
1. 新建自定义组(Template Group)
新建组,命名为userDefined
2. 在刚建的自定义组下新建模板(Live Template)
1)新建模板Method Comment,命名为mc
2)模板内容:**(注意:第一行,只有一个*而不是/*)
*
* @Author: $user$
* @Date: $date$ $time$
* @Param: $param$
* @Return: $return$
* @Description: TODO
*/
3)上图中No applicable contexts yet
警告,是因为没有设置模板的应用场景导致,点击Define
设置为Java
即可:
4)设置参数获取方式:
说明: 上图中红框标记的
“Expand with”
参数是用来设置生成快捷键的,可以根据自己的习惯自行设置,默认Tab键
重点说明
正确演示:
正确的生成方式为:/* + 自定义的Live Template模板名称 + 快捷键(默认Tab键)
以我上面设置的为例:/*mc + tab键
实际正确效果:
错误演示:
错误的生成方式为:自定义的Live Template模板名称 + 快捷键(默认Tab键)
以我上面设置的为例:mc + tab键
实际错误效果:
说明:
这样操作不仅注释格式错误,而且@Param和@Return参数并没有获取到值,最开始网上找了很多添加groovyScript脚本的方式,然并卵,在此踩过坑了,希望大家别再这种问题上浪费时间,特此奉上!!!