开发规范

1. 页面命名全小写,以_隔开,如 dialog_meet_detail.html。
2. 样式命名全小写,用-隔开,如.trend-svg-map。
3. js 里函数方法用驼峰命名,如 trendSvgMap。
4. 类名使用 UpperCamelCase 风格。
5. 方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格。
6. 常量命名全部大写,单词间用下划线隔开。
7. 类、类属性、类方法的注释必须使用 Javadoc 规范,使用/**内容*/格式,
不得使用// xxx 方式。
8. 所有的抽象方法(包括接口中的方法)必须要用 Javadoc 注释、除了返回值、
参数、异常说明外,还必须指出该方法做什么事情,实现什么功能。对子类
的实现要求,或者调用注意事项,请一并说明。
9. 方法内部单行注释,在被注释语句上方另起一行,使用//注释。方法内部多
行注释使用/* */注释,注意与代码对齐。
10. 所有的枚举类型字段必须要有注释,说明每个数据项的用途。
11. 代码修改的同时,注释也要进行相应的修改,尤其是参数、返回值、异常、
核心逻辑等的修改。
12. 在前后端交互的 JSON 格式数据中,所有的 key 必须为小写字母开始的
lowerCamelCase 风格,符合英文表达习惯,且表意完整。
13. 生产环境禁止直接使用 System.out 或 System.err 输出日志或使 用
e.printStackTrace()打印异常堆栈。

原文地址:https://www.cnblogs.com/hxun/p/14205677.html