Java编程规约：注释规约

I 注释规约

【强制】

• 方法内部单行注释，在被注释语句上方另起一行，使用 // 注释。
• 方法内部多行注释使用 /* */注释，注意与代码对齐。
• 所有的枚举类型字段必须要有注释，说明每个数据项的用途
  

【推荐】

代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等

说明：代码与注释更新不同步，就像公路网与导航软件更新不同步一样，如果导航软件严重滞后，就失去了导航的意义。

【参考】

• 注释代码，需在上方详细说明注释动机

对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三个斜杠(///)来说明注释掉代码的理由：