idea中设置代码注释模板

写在前面

在当下开发框架越来越简单易用，伴随而来的是程序员的代码质量反而越来越低，框架或语法的强大使得代码自由度更高，更加灵活的使用方式稍微不注意会导致代码因为难懂而成为垃圾，这里需要一个简单的代码注释规范模板。

一、在idea中设置类文件注释模板

• 设置路径（File-->settings-->Editor-->File and Code Templates-->Files）
  
• 模板代码（贴到上图的红框位置即可）

/**
 * @description: TODO
 * @author $USER
 * @date $DATE $TIME
 * @version 1.0
 */

• 效果
  

• 其他文件类型的代码注释同理，比如html等

二、在idea中设置方法文件注释模板

• 设置路径（File-->Settings-->Editor-->Live Templates）
  
• 模板代码（贴到第6步红框位置，注意这里第一行是*不是/*）

* 
 * @description: $description$ 
 * @params: $params$ 
 * @return: $returns$ 
 * @author: $user$
 * @date: $date$ $time$
 **/

• 设置变量(接着上图第7步点击按钮的操作)
  

  • params内容：
    groovyScript("def result = '';def params = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n ' : '')}; return result == '' ? null : '\\r\\n ' + result", methodParameters())
  • returns内容：
    groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())

• 修改代码注释生成的快捷键
  

• 效果

• 注意
  • 第4步模板名称，是申明如何触发模板，如果不是*而是别的，如ABC，那你的模板就得是/*+ABC+快捷键来触发了。
  • 第6步的模板代码，第一行是*不是/*。
  • 设置参数名时必须用$参数名$的方式，否则第7步按钮弹起的页面中读取不到你设置的参数名

最主要的还是需要形成注释强约束，将这个代码模板当作团队开发的强制措施，来保证代码基本的理解和规范。