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

类的注释模板配置

1、配置全局USER

在此配置全局USER，用于填充自动生成的注释中的作者@author属性。

注释模板中的user参数是默认是获取系统的用户（当然注释作者也可以直接写固定值），如果不想和系统用户用同一个信息，可以在IDEA中进行配置。IDEA依次打开Help->Edit Custom VM Options...。在最下面增加一行 -Duser.name=username。

其中username就是你希望为user参数的赋值配置类注释模板（配置后需要重启IDEA生效）。

2、配置注释模板

Preferences -> Editor -> File and Code Templates -> Includes -> File Header

注释模板内容：

/**
 * @project ${PROJECT_NAME}
 * @description: ${description}
 * @author ${USER}
 * @date ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
 * @version 1.0
 */

配置完成后，就可以新建一个类进行测试了。新创建java文件时，会提示输入类描述description

如果发现新建的文件注释顺序和模板不一样，可以检查下如下的配置：
Preferences->Editor->Code Style ->Java->JavaDoc 中的配置(取消勾选)：

方法的注释模板配置

File -> Settings -> Editor -> Live Templates 如下图

点击第四步的 + 选择 Template Group，创建分组，分组名自定义，例如MyTemplates ，点击OK即可。

在列表中找到 MyTemplates 分组，选中，再次点击右边的 + 号，选择 Live Template

配置的内容：
Abbreviation：模板的缩写，可以是【/】【/**】【】等，看个人习惯了，后面会介绍用法。
Description：模板的描述，方便自己以后查找。
Template text：模板的内容，参数名用 $参数名$ 格式。
Options→Expand with：模板的扩展快捷键，可以按照个人习惯选择，我用的是Enter键，后面会介绍用法。

配置模板格式(Template test)：

/**
 * @description 
 * @author $user$
 * @date $date$
 * @param $params$       
 * @return $return$
 */

点击 Edit variables

设置一下应用场景, 由于我是用Java语言编写代码, 那么范围直接选Java就可以了. 没设置过的是 Define (如果修改过的就是change) , 点击一下选择Everything → Java