T31训练营笔记（6）编码规约

1. 编码规约缘起
1.1 编码规约存在的意义
减少代码的维护成本
改善可读性
提高团队开发的合作效率
锻炼出更加严谨的思维
身心愉快

2. 代码格式与命名风格
2.1 两个要求
（1）命名体现代码元素特征
抽象类命名使用Abstract或Base开头
异常类命名使用Exception结尾
测试类命名以它要测试的类名开始，以Test结尾
类型与中括号紧挨相连来定义数组
枚举类名带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开
（2）命名最好望文知意
不规范的缩写会导致理解成本增加
望文知意指的是英文

3. 常量定义设计与规约
3.1 不允许任何魔法值（即未经预先定义的常量）直接出现在代码中
3.2 统一常量一定需要统一的管理，统一的维护，统一的使用
3.3 常量的复用层次有五层
（1）跨应用共享常量：放置在SDK中
（2）应用内共享常量：放置在一方库中
（3）子工程内部共享常量：当前子工程的constant目录下
（4）包内共享常量：当前包下单独的constant目录下
（5）类内共享常量：直接在类内部private static final 定义
3.4 常量命名应该全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长

4. 注释规约
4.1 注释的作用
提高代码可读性
使程序条理清晰
方便后期代码维护
方便程序员间的交流沟通
生成帮助文档
警示作用，防止踩坑

5. 前后端设计与规约
5.1 前后端交互的API，需要明确协议、域名、路径、请求方法、请求内容、状态码、响应体
5.2 Java与JS对数字类型变量处理方式不同。如果数字太大或有精度要求，最好使用String类型