IDEA设置类和方法的注释模板

博主最近从.NET转Java，Java的开发工具使用IDEA，所谓工欲善其事，必先利其器，首先要熟悉IDEA工具的使用，才能为后续的开发提高效率。本篇博客主要记录IDEA关于注释模板的配置和使用。一般我们开发程序都会涉及到注释，注释对于项目很有必要的，特别是对于项目后的维护。

IDEA中我们可以为新建的类、接口、枚举等文件设置注释模板，为方法设置注释模板，统一注释风格以及提高添加注释的效率。

 

为IDEA配置全局编码格式

在IDEA中打开File-> Settings...弹出框中，选择Editor->File Encodings设置全局及项目的编码格式，国内我们为了让中文不乱码统一设置为UTF-8的格式：

为新建文件添加注释模板

在IDEA中打开File-> Settings...弹出框:

在Settings弹出框中选择Editor->File and Code Template，然后选择Includes选项卡中的File Header项:

在右侧的设置框中设置新建文件的Header模板实现给类、接口、枚举等添加注释模板，博主的设置的模板如下，可以通过${variable}调用Description中列举的变量:

/**
 * <p></p>
 *
 * @author flyduck ${DATE} ${TIME}
 * @version V1.0
 * @modify by user: flyduck ${DATE}
 * @modify by reason:{原因}
 **/

点击Apply或者OK按钮完成文件头的注释模板，实现类、接口、枚举的注释。

 

为方法添加注释模板

在Settings弹出框中选择Editor->Line Template，然后点击右侧的+，选择Template Group创建自定义的Template Group。博主设置的Template Group名为MethodTemplate:

创建Template Group后，选中创建的Template Group，点击右侧的+，选择Line Template创建自定义的Line Template。博主的设置如下，在Abbreviation中设置*，表示输入*+Tab键后输出Template text：

Template text的设置如下，需要添加注释的时候，输入/ + * + Tab键：

**
 * $description$
 * 
 * @author flyduck
 * @date $date$ $time$
 * @param $param$
 * @return $return$
*/

方法模板中也可以通过$variable$使用变量，点击模板内容下面的Change（未设置是Define文字）设置模板应用的地方，博主设置为Java：

设置好模板的应用地方后，点击Edit variables设置变量，以便模板中的变量能够正常的工作，博主设置如下：

设置好后点击OK即可。

 

注释效果

通过IEDA创建HomeController类，创建好文件后会自动在类上面添加注释模板，效果如下：

在方法上面输入/* + Tab键，自动生成方法注释，效果如下：

IDEA配置了注释模板后，大大的提高了写注释的效率，这里做一个简单的记录，同时也可以提供给其他才使用IDEA工具的小伙伴们一些参考，如果有地方描述不准确或者错误，欢迎网友的反馈和建议！