在idea中为类和方法自动生成注释

• 一、设置类级别的注释(创建类是自动生成注释)
• 二、设置方法级别的注释

一、设置类级别的注释(创建类是自动生成注释)

图中的代码块:

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

/**
* @author sjl
* @date ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
*/

上述8个变量说明:

$ {USER}：当前系统登录的用户名，如果你的系统用户名是windows默认的Adminstrator，千万别用，鬼知道你 的同事里有多少人也是Administrator

${DATE}：当前系统设置的日期格式，作为一个有强迫症的程序员，不能接受同一项目的注释里有超过一种的日期格式

${TIME}：当前系统设置的时间格式，作为一个有强迫症的程序员，不能接受同一项目的注释里有超过一种的时间格式

${YEAR}：完整的年份，比如 2018

${MONTH}：完整的月份，比如 01

${DAY}：完整的日期，比如 17

${HOUR}：24小时制的小时，比如 16

${MINUTE}：完整的分钟，比如 52

二、设置方法级别的注释

1. 如图，创建一个新的group。
   
2. 然后在添加模板。
   
3. 编辑模板。
   
   步骤说明:

• 1是设置的快捷键，我这里设置的三个星号。

• 2是模板代码块

  **
  * @description $description$
  $params$  //也可以将此行改为   * @params $params$
  * @return  $return$
  * @author  SJl
  * @date  $date$ $time$
  *
  */
  

  注意这里的代码块前面是没有/的，在方法外敲/+***+Enter就能生成注释，如果你写成/**开头的话在方法外敲是不能获取return和params参数的，只有在方法内敲才能获取到。

• 3是选择生效区域，点击define，选择everyWhere 或者 java。

• 4是参数设置。
  
  2的模板代码块如果你写的是* @params $params$，参数设置请选择 methodParameters()，如果你写的是$params$，请粘贴以下代码

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

• 5是选择按键，默认的是Tab，我一般选Enter。

6. 两种不同的显示效果。
   

参考链接