IDEA 类/接口/枚举/注解文件模板的设置方法注释

浅浅的花香味﹌ 2022-10-05 03:57 169阅读 0赞

### 文章目录 ###

*   *  预设变量
     *  类 接口 枚举 注解 模板设置
     *  links

## 预设变量 ##

Predefined variables will take the following values:

<table> 
 <thead> 
  <tr> 
   <th align="left">变量名</th> 
   <th>值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">${PACKAGE_NAME}</td> 
   <td>name of the package in which the new class is created</td> 
  </tr> 
  <tr> 
   <td align="left">${NAME}</td> 
   <td>name of the new class specified by you in the Create New Class dialog</td> 
  </tr> 
  <tr> 
   <td align="left">${USER}</td> 
   <td>current user system login name</td> 
  </tr> 
  <tr> 
   <td align="left">${DATE}</td> 
   <td>current system date</td> 
  </tr> 
  <tr> 
   <td align="left">${TIME}</td> 
   <td>current system time</td> 
  </tr> 
  <tr> 
   <td align="left">${YEAR}</td> 
   <td>current year</td> 
  </tr> 
  <tr> 
   <td align="left">${MONTH}</td> 
   <td>current month</td> 
  </tr> 
  <tr> 
   <td align="left">${MONTH_NAME_SHORT}</td> 
   <td>first 3 letters of the current month name. Example: Jan, Feb, etc.</td> 
  </tr> 
  <tr> 
   <td align="left">${MONTH_NAME_FULL}</td> 
   <td>full name of the current month. Example: January, February, etc.</td> 
  </tr> 
  <tr> 
   <td align="left">${DAY}</td> 
   <td>current day of the month</td> 
  </tr> 
  <tr> 
   <td align="left">${HOUR}</td> 
   <td>current hour</td> 
  </tr> 
  <tr> 
   <td align="left">${MINUTE}</td> 
   <td>current minute</td> 
  </tr> 
  <tr> 
   <td align="left">${PROJECT_NAME}</td> 
   <td>the name of the current project</td> 
  </tr> 
 </tbody> 
</table>

## 类 接口 枚举 注解 模板设置 ##

`Editor` \--> `File and Code Template` \--> `File` \--> `Class`  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70]

编辑模板内容如下：

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
    #parse("File Header.java")
    
    /** 
     * Description TODO
     * @ClassName ${PACKAGE_NAME}.${NAME}
     * @Version 1.0
     * @Date: ${DATE} ${TIME}
     * @User ${USER}
     * @Author yujin.wu@outlook.com
     */
    public class ${NAME} {
    }

新建一个类，测试：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70 1]  
在其他类中引用该类：

![在这里插入图片描述][20210606105630776.png]

而后依次设置 Interface, Enum, AnnotationType。  
只需要换第一个 @xxx 信息即可。

@ClassName
    @InterfaceName
    @EnumName
    @AnnotationName

以上四行不强制，可自行命名。

## links ##

*  [IDEA 设置方法的注释模板 live template 可正确生成参数列表 @param][IDEA _ live template _ _param]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70]: /images/20221005/48a38dc9dc064887a46203011379dc13.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70 1]: /images/20221005/4550bee1405d45abbcc7087ef493533b.png
[20210606105630776.png]: /images/20221005/54e134d8febc43dcb93cc8d097ba49b9.png
[IDEA _ live template _ _param]: https://wuyujin.blog.csdn.net/article/details/117622025