java代码编写规范

统一类注释和方法注释说明

IDEA配置说明

术语介绍

• Abbreviation ：<命令>
• Description：<描述>
• Template text：<配置模板>

操作步骤

1. 在配置当中找到Live Template,右边加号先添加一个Template Group,选中该分组再点击加号添加一个Live Template；
   
2. 创建Template Group，命名为Custom Template;
3. 添加Live Template；
   
   点击Define | Change，如下图所示
   点击Edit variables，修改变量对应的表达式
   
   勾选Reformat according to style，编辑完成之后，依次点击ok，apply

常用模板介绍

类注释

• Abbreviation : ct
• Description：类注释
• Template text：

   /**
     * Description
     * <br> $END$
     * @date $CREAT_DATE$
     * @author your name
     **/
  

• Edit variables：
  date：

    date("yyyy-MM-dd"）
  

方法注释

• Abbreviation : mt

• Description：类注释

• Template text：

  **
    * Description 
    * <br> $END$
    $param$ 
    * @date $CREAT_DATE$
    * @author your name
    **/
  

• Edit variables：

  param：

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

  CREAT_DATE：

  date("yyyy-MM-dd"）
  

日志模板

• Abbreviation : lgt
• Description：声明Logger变量
• Template text：

  /**
   * 声明Logger变量
   */
  private static final org.slf4j.Logger logger = org.slf4j.LoggerFactory.getLogger($ClassName$.class);
  

• Edit variables：
  ClassName： className()

TODO注释模板

• Abbreviation : todo
• Description：表示需要实现，但目前还未实现的功能
• Template text：

   // TODO: $DATE$ $END$
  

• Edit variables：
  DATE：

   date("yyyy-MM-dd HH:mm:ss"）
  

XXX注释模板

• Abbreviation : xxx

• Description：勉强可以工作，但是性能差等原因

• Template text：

    // XXX: $DATE$ $END$
  

• Edit variables：

  DATE：

    date("yyyy-MM-dd HH:mm:ss"）
  

FIXME注释模板

• Abbreviation : fixme

• Description：代码是错误的，不能工作，需要修复

• Template text：

    // FIXME: $DATE$ $END$
  

• Edit variables：

  DATE：

    date("yyyy-MM-dd HH:mm:ss"）
  

JS方法注释模板

• Abbreviation : jst

• Description：JS方法注释模板

• Template text：

  /**
  * Description
  * <br> Created by your name  on $CREAT_DATE$
  * <br> $END$
  **/
  

• Edit variables：

  CREAT_DATE：

   date("yyyy-MM-dd"）