实时代码模板只是为了让我们更加高效的写一些固定模式的代码,以提高编码效率,同时也可以增加个性化。
官网介绍 Live Templates: https://www.jetbrains.com/idea/help/live-templates.html� 简单的我们练习一下,先看看如何使用?
介绍一下界面的按钮说明:
�
- 如上图标注 1 所示,除了 IntelliJ IDEA 预设的模板之外,我们还可以创建新组和新实时代码模板,其中组是用来包含实时代码模板的。
� + 如上图标注 2 所示,output 是组名,告诉开发者,这组里面实时代码模板都是用来做输出的。serr 表示实时代码模板输出 System.err 的简称,所以这个不是一个完整的单词,不需要读懂,只需要记忆。 - � 如上图标注 3 所示,实时代码模板的内容,其中用到了预设的变量 $END$。
�+ 如上图标注 4 所示,可设置该实时代码模板的试用范围,比如图上的 serr 这是 Java 代码,所以试用范围我们就应该只是 Java 文件上或是 JSP 这类文件上,设置在 HTML 或是 CSS 文件上就完全没有多大意义了。
�+ 如上图标注 5 所示,勾选了辅助的功能:- Reformat according to style 对生成的代码进行格式化。
- Shorten FQ names 关于此设置的说明我没有找到,所以暂时无法给个很少的解释,只是看到材料说明一般需要勾上此设置,如果您有好的答案,还请联系我。
变量参数和函数的介绍
代码模板内容为:
System.out.println("-->> hanpang <<--$VAR1$值=" + $VAR1$ + "," + "当前类=$CLASS_NAME$.$METHOD_NAME$()");$END$
+ $VAR1$、$CLASS_NAME$、$METHOD_NAME$ 都为自己定义的变量名。设置变量名只要用两个 $ 包住即可。
每个变量在代码输出的时候都是一次光标位置,光标跳动顺序从左到右,每次跳动按 Enter。
继续完成设置工作:
点击按钮 Edit variables,可以对编辑代码内容的变量。
- 如上图标注 1 所示,演示中变量名 $CLASS_NAME$、$METHOD_NAME$ 会自动输出当前类名和方法名是因为使用对应的函数 className() 和 methodName()。
- 如上图标注 2 所示,如上面介绍的,每个变量都是一次光标位置,但是演示中变量名 $CLASS_NAME$、$METHOD_NAME$ 没有进入,是因为勾选了 Skip if defined。
- 如上图标注 3 所示,可以改变变量光标跳转时的顺序。
- 内置函数介绍: https://www.jetbrains.com/idea/help/live-template-variables.html
对于官网这些函数这里就不在累赘,官网有详细的介绍,如果你还看不懂,可以看 IntelliJ IDEA 已经预设各个实时代码模板,基本上常用的函数都有被引用过,你可以通过学习这些预设的实时代码模板来揣测其函数的用法。
文件代码模版讲解
IntelliJ IDEA 默认新建类自带的类注释格式一般不够友好或是规范,所以我们一般需要自己根据公司编码规范进行设置。
认识一下界面:
- 如上图标注 1 所示,文件代码模板支持的类型基本常见的文件类型都涵盖了。
- 如上图标注 2 所示,这是 Java 文件模板新建的代码模板,其中 ${PACKAGE_NAME}、${NAME} 是 IntelliJ IDEA 预设的变量。
- 如上图标注 3 所示,IntelliJ IDEA 的文件代码模板是可以使用 Velocity Template Language (VTL) 进行书写的。如图 2 上的 #if ... #end 和 #parse 都是 VTL 的语法。
- 如上图标注 4 所示,介绍当前文件模板的一些信息,以及一些预设变量的作用介绍。
- 如上图标注 5 所示,这四个按钮是文件代码模板的主要操作按钮,四个操作分别是:
- Create Template 创建一个文件代码模板。
- Remove Template 删除一个文件代码模板,标注 1 所示的这些预设模板是不允许删除的,只能能删除预设之外的新增的。
- Copy Template 复制一个文件代码模板。
- Reset To Default 对被修改的预设文件代码模板,还原到默认状态。
分析说明:
#parse("FileHeader.java") 这是代表引入的文件�下图标注黄色框所示,
IntelliJ IDEA 还支持其他常见会新建的文件类型,基本上我们根本不用担心有不支持的文件类型,
常用的基本都被涵盖了。
修改自己想要的模版,来吧!Come On!!
如上图标注箭头所示,${DESCRIPTION} 是我们自己定义的变量,自定义变量格式有两种方式:$变量名 或 ${变量名}。
自定义的变量在创建对应的文件时候就必须输入内容,需要自己动手测试一下。
当我们创建Demo类的时候,点击OK之后,会让我们输入描述的内容。
我发现作者显示的是我操作系统的登录用户名称,我们可以把这个位置写死!或者使用定义变量的方式!
当我们需要用到一个固定值的自定义变量的时候并且该变量多个地方被引用,我们可以通过 VTL 语法的 �#set( $变量名 = "变量值内容" ); 来设置。
生成的效果图如下:
packagecom.hanpang.java;
/**
*类说明:测试使用
*
*@Author:胖先生
*@Create:2016-04-1515:58
*@Home:http://www.cnblogs.com/pangxiansheng/
*/
publicclassDemo{
}
来自网络
文件代码模板预设的变量 : https://www.jetbrains.com/idea/help/file-template-variables.html
因为变量的命名太明了不过了,所以这里不多讲解,直接贴出官网的英文解释:
- ${PACKAGE_NAME} - the name of the target package where the new class or interface will be created.
- ${PROJECT_NAME} - the name of the current project.
- ${FILE_NAME} - the name of the PHP file that will be created.
- ${NAME} - the name of the new file which you specify in the New File dialog box during the file creation.
- ${USER} - the login name of the current user.
- ${DATE} - the current system date.
- ${TIME} - the current system time.
- ${YEAR} - the current year.
- ${MONTH} - the current month.
- ${DAY} - the current day of the month.
- ${HOUR} - the current hour.
- ${MINUTE} - the current minute.
- ${PRODUCT_NAME} - the name of the IDE in which the file will be created.
- ${MONTH_NAME_SHORT} - the first 3 letters of the month name. Example: Jan, Feb, etc.
- ${MONTH_NAME_FULL} - full name of a month. Example: January, February, etc.