IDEA配置注释模板（类和方法）

背景

代码编程规范：注释，注释，方便后来者的代码阅读和责任出处

IDEA类注释模板配置

1、打开File-->Settings-->Editor-->File and Code Templates,选择Includes下面的File Header

注释模板：

/**
 * @Description: TODO
 * @author: ${USER}
 * @date: ${DATE} ${TIME}
 */

 

提示：此处注释模板里面获取变量值的格式必须是 ${ 变量值 }，变量必须大写，否则获取不到，在此处设置注释模板后，当你新建java类的时候会自动生成注释。

效果：

2、对于个别公司来说，编写的代码都会带有自己的版权声明，此处来讲解版权声明的配置

模板：

/**
 * ${NAME}.java
 * ${PACKAGE_NAME}
 * Copyright (c) ${YEAR}, 北京XXXX科技有限公司版权所有.
*/

 

注：此处获取变量的格式和上述相同

效果：

方法注释

1、打开File-->Settings-->Editor-->Live Templates,点击右上角的 + 号，选择Template Group

2、创建分组这里可以按照个人爱好起名称

3、选中创建组，点击右上角 + 号，选择Live Template

4、创建注释方法

注释模板：

/**
 * @Function: TODO
 * @author: 用户名称
 * @Date: $date$ $time$
 * @param: $param$
 * @return: $return$
 */

 

5、选择注释的文件类型

6、设置注释参数类型

效果：

提醒：此处的注释模板获取参数的格式：$参数名$，如：$return$，否则获取不到