IDEA设置-自动生成类注释和方法注释

 

1、新建文件添加Java类注释

1.1设置includes-File Header

设置File Header 比设置Files 更有效果，所有解析File Header 的文件类型都会添加注释。

依次点击Preferences -> Editor -> File and Code Templates -> includes打开模板配置文件File Header 

 

 

注意大小写

/**
  *@ClassName ${NAME}
  *@Description TODO
  *@Author ${USER}
  *@Date ${DATE} ${TIME}
  *@Version 1.0
*/


简化版本可以填写这个（推荐）：
/**
  *@Description 类功能简要描述
  *@Author ${USER}
  *@Date ${DATE} ${TIME}
*/

/**
  *@author ${USER}
  *@date ${DATE} ${TIME}
*/

${USER}可以填如下：
William Feng
Feng Zhi
fengzhi
fengzhi8
feng zhi
William
等

添加类注释模板（包含功能描述，作者，日期）

/**  
  * @description xx
  * @author erp
  * @date ${DATE}${TIME}
*/

参考如下：

/**
  *@Description 类功能简要描述
  *@Author William Feng
  *@Date ${DATE} ${TIME}
*/

/**
  *@Description 类功能简要描述
  *@Author Feng Zhi
  *@Date ${DATE} ${TIME}
*/

/**

  *@Description 类功能简要描述
  *@Author fengzhi8
  *@Date ${DATE} ${TIME}
*/

 

1.2其他配置项变量

其他配置项变量（可选）：
${PACKAGE_NAME} : 包路径
${NAME} : 文件名
${USER} ： 主机用户名
${DATE} ： 系统当前日期，格式为：yyyy/mm/dd
${TIME} ： 系统当前时间 格式为：HH:mm
${YEAR}：当前年
${MONTH}：当前月
${MONTH_NAME_SHORT}： 月份名称简写；如：Jan, Feb, etc.
${MONTH_NAME_FULL} ： 月份名称全拼；如：January, February.
${DAY} ：当前天
${DAY_NAME_SHORT} ：星期简写；如：Mon, Tue, etc.
${DAY_NAME_FULL}：星期全写；如：Mon, Tue, etc.
${HOUR} ： 当前小时
${MINUTE}：当前分钟
${PROJECT_NAME}： 项目名称

 

1.3设置Files里面的Class文件类型

只会对Class的java类生效，其它类型文件(enum inteerface)不会生效

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

简化版本可以填写这个（推荐）：

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
  *@Description 类功能简要描述
  *@Author ${USER}
  *@Date ${DATE} ${TIME}
*/
public class ${NAME} {
}

 

2、自动生成方法注释或者变量注释

2.1方式一（推荐 更详细）

Bean注入添加中文描述

idea默认输入 /**+ENTER，补充功能描述，参数描述和返回值描述

 

 

*
 * @Description TODO
 * @Author fengzhi8 
 * @Date $date$ $time$
$param$
 * @return $returns$
 * @throws RuntimeException????? or Remove-This-Line TODO
 */ 

注意首字母大小写

注意空格

注意特殊格式

注意$param$的公式

@throws的工时expectedTypes()不能生效

 

以上图示6的弹框如下，配置对应表达式即可

其中param配置表达式如下，输出方法对应参数:

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] +' '+ params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())  

 2.2方式二

大体大同小异

输入/*，按回车，自动生成方法注释和变量注释等

* 
 * @Description //TODO
 * @Author zhifeng
 * @Date $date$ $time$ 
 * @Param $param$
 * @return $return$
 **/