IDEA配置代码注释模板

一、创建JAVA文件时自动生成文件注释

配置步骤

• 配置路径
  File → setting → Editor → File and Code Templates → includes
  
  

• 配置内容

/**
 *  TODO
 *  @author chenxiang
 *  @date ${DATE} ${TIME}
 *  @version 1.0
 */ 

直接复制即可

最终效果

配置完成后效果如下图所示：

二、配置类注释模板

配置步骤

• File → setting… → Editor → Live Templates
  
• 点击右侧 + 号，选择创建模板组，并输入模板的名称：
  
  
• 选择新创建的模板组，点击右侧 + 号，创建模板：
  
• 配置模板具体内容一
  
• 配置模板具体内容二：
  
• 配置模板作用范围
  
  模板内容如下所示：

/**
 *  TODO
 *  @author chenxiang
 *  @date $Date$ $time$
 *  @version 1.0
 */ 

最终效果

三、方法注释模板

配置步骤

• 选择新创建的模板组，点击右侧 + 号，创建模板：
  
• 方法模板具体配置步骤一：
  
• 方法模板具体配置步骤二：
  
  自定义优化函数如下所示：（直接复制使用即可）

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

• 配置模板作用范围
  
  模板内容如下所示：

*
 * TODO
 * @author  chenxiang
 * @date   $date$ $time$ $param$
 * @return      $return$
 * @Exception   $exception$
 * 
 */

• 注意事项
  不要将模板配置为 / 或 /**** 等，会导致方法参数和返回值无法被正确的获取到

/**
 * TODO
 * @author  chenxiang
 * @date   $date$ $time$ $param$
 * @return      $return$
 * @Exception   $exception$
 * 
 */

最终效果