2.6、注释规范

2.6.1、Java、Js文件注释

放在文件名上方相邻位置，格式如下：

 /**
  * 功能描述
  * @author JSPGen
  * @copyright  (c) JSPGen.com
  * @created  2012年03月
  * @email  jspgen@163.com
  * @address  www.jspgen.com
  */
  

注：js文件注释，需在第一行后添加感叹号，如：/**！

 

2.6.2、方法注释

放在方法名上方相邻位置，格式如下：

 /**
  * 方法描述
  * @param key   参数描述
  * @return String
  */
  public String getKey(String key) {
  return key;
  }

2.6.3、枚举注释

放在方法名上方相邻位置，枚举元素注释需放在元素左边，格式如下：

  /**
  * 成正比缩放基数
  */
  public enum TestEnum {
  /**自动识别*/auto, /**以宽度为准*/width, /**以高度为准*/height
  };
  

2.6.4、变量、常量注释

放在其上方相邻位置，格式如下：

 /**
  * 时间时间截，默认当前时间
  */
  private Long time = null;