IntelliJ IDEA 类代码模板注解自定义

本篇内容为你们提供的是IntelliJ IDEA 使用教程中的文件代码模板的使用，IntelliJ IDEA是java语言开发的集成环境，IntelliJ在业界被公认为最好的java开发工具之一，尤为在智能代码助手、代码自动提示、重构、J2EE支持、Ant、JUnit、CVS整合、代码审查、 创新的GUI设计等方面的功能能够说是超常的。 。感兴趣的同窗能够参考学习下，具体内容以下：

文件代码模板的介绍

文件代码模板能够简单理解为：咱们在项目中建立某些类型文件时，就已经在对应这些新文件中预设了代码内容。由于文字表达都带有点无力，因此下面用 Gif 动态图来演示。

• 如上图 Gif 所示，IntelliJ IDEA 默认新建类自带的类注释格式通常不够友好或是规范，因此咱们通常须要本身根据公司编码规范进行设置。

• 如上图 Gif 所示，这是根据我本身的需求进行设置的类注释，这种注释方式会更友好。

根据演示咱们应该已经很好地理解了文件代码模板是什么东西了。对此咱们能够衍生出不少玩法，好比：咱们的项目 Controller、Service、Dao 等经常使用新对象都是要各自继承某个类、实现某些接口或预设某些方法，也均可以经过这样的文件代码模板来实现。

• 官网介绍：https://www.jetbrains.com/idea/help/file-and-code-templates.html

文件代码模板的设置

• 如上图标注 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 对被修改的预设文件代码模板，还原到默认状态。

• 如上图标注 1 所示，IntelliJ IDEA 还支持其余常见会新建的文件类型，基本上咱们根本不用担忧有不支持的文件类型，经常使用的基本都被涵盖了。

• 如上图标注 1 所示，该 File Header 文件就是前面 Java 文件代码模板中引入语句中 #parse("File Header.java") 文件。

 

• 如上图标注箭头所示，${DESCRIPTION} 是咱们本身定义的变量，自定义变量格式有两种方式：$变量名 或 ${变量名}。
• 自定义的变量在建立对应的文件时候就必须输入内容，这个在本文最上面的 Gif 演示中已经有体现了。

• 如上图 Gif 所示，当咱们须要用到一个固定值的自定义变量的时候而且该变量多个地方被引用，咱们能够经过 VTL 语法的#set( $变量名 = "变量值内容" ); 来设置。

• 由于 Code 模块改动的人很少，因此放在最后。咱们是没法新建、删除 Code 里面的代码模板。
• 如上图标注 1 所示，在咱们经过快捷方式生成某个类的测试方法时候会自动调用此 Code 模板，因此咱们能够解释该 Code 功能主要用在 IntelliJ IDEA 自动帮咱们生成某些代码的时候引用的模板。

文件代码模板预设的变量

由于变量的命名太明了不过了，因此这里很少讲解，直接贴出官网的英文解释：

• ${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.

PHP 的文件类型预设的变量比上面的还多一点，具体能够查阅官网：

• 官网变量介绍：https://www.jetbrains.com/idea/help/file-template-variables.html

后续有不少开发填坑的文章发布，若是对你有帮助，请支持和加关注一下

http://e22a.com/h.05ApkG?cv=AAKHZXVo&sm=339944

https://shop119727980.taobao.com/?spm=0.0.0.0