前言
今天是孤尽老师分享的编码规约。
编码规约的意义
- 减少代码的维护成本
- 改善可读性
- 提高团队开发的合作效率
- 锻炼出更加严谨的思维
- 身心愉快
命名风格与代码格式
体现元素特征
- 抽象类命名使用Abstract或Base开头
- 异常类用Exception结尾
- 测试类命名以测试类名开始,以Test结尾
- 类型与中括号紧挨相连定义数组
- 枚举类带上Enum后缀,枚举成员名称要全大写,单词间用下划线隔开
望文生义
常量定义设计规约
不用魔法值
常量统一定义,管理,维护
常量复用层次
- 跨应用共享变量:放置在SDK中
- 应用内共享常量:放置在一方库中
- 子工程内部共享变量:当前子工程的constant目录下
- 包内共享变量:当前包下单独的constant目录下
- 类内共享变量:类内部private static final定义
注释规约
注释的作用
- 提高可读性
- 程序条理清晰
- 方便后期维护
- 方便程序员之间交流
- 生成帮助文档
- 警示作用以防踩坑
前后端设计规约
前后端交互的API,需要明确协议、域名、路径、请求方法、请求内容、状态码、响应体等。
- 超大整数,一律放回String
- HTTP请求通过URL参数,不超过2048字节