idea设置file template

最新推荐文章于 2023-06-09 19:49:44 发布

原创最新推荐文章于 2023-06-09 19:49:44 发布 · 3.4k 阅读

2 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#idea

IDEA设置专栏收录该内容

1 篇文章

订阅专栏

本文详细介绍如何在IDEA中自定义FileTemplate，包括使用Apache Velocity语法和预定义变量，如${PACKAGE_NAME}

idea设置file template

在使用idea创建类或者接口文件时，idea都是使用file template里面定义好的模板格式

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
public class ${NAME} {
}

然而默认的模板并没有生成自己需要的注释，那么我们怎么去配置呢？

其实这个模板设定的语言是Apache Velocity，但是我们不需要深入去了解这个，因为idea已经给定了很多的变量，我们只要学会怎么去使用就行了。

idea java创建模板变量
变量名称	解释
${PACKAGE_NAME}	新建类所在包的路径
${NAME}	新建类的名称
${USER}	当前计算机的用户名
${DATE}	当前系统日期，例：9/26/2019
${TIME}	当前系统时间，例：10:13
${YEAR}	当前年份
${MONTH}	当前月份
${MONTH_NAME_SHORT}	当前月份英文单词简写，例：Feb
${MONTH_NAME_FULL}	当前月份英文单词全拼，例：February
${DAY}	当前月的日期
${HOUR}	当时的小时
${MINUTE}	当时的分钟
${PROJECT_NAME}	当前项目的名称

好了，变量名都弄清楚了，那么看一下精简的Java类的创建模板吧。其中用@author表明此类的作者，用@date注解标明文件文件创建日期，其上方默认为文件的描述相关信息。并用todo标明以方便提醒自己修改。

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
 * todo 待增加类描述 
 *
 * @author ***
 * @date ${YEAR}年${MONTH}月${DAY}日 ${TIME}
 */
public class ${NAME} {
}

另外由于工作的开发环境我用个人姓名标识，个人平时的开发使用邮箱来标识，因而标明的@author信息不同，所以想通过一种方式来自动判断是工作环境还是个人开发环境。由于目前公司开发的包名前缀固定，所以想通过包名来判定，于是我便把模板修改了一下：

#set($str=${PACKAGE_NAME})
#if($str.length() > 16)
    #set($str=$str.substring(0, 16))
#end
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
 * 
 * @author 
    #if ($str.length() == "公司包名前缀") your name
    #else ****@email.com 
    #end
 * @date ${YEAR}年${MONTH}月${DAY}日 ${TIME}
 */
public class ${NAME} {
}