2019-08-20

编码规范

今天我们项目组难得有时间，一起讨论下接下来的计划，其中我提到当前项目代码质量差，不规范的问题。

作为一个Javaer，谈到代码规范，当仁不让祭出 阿里巴巴编程手册。

晚上空闲基于阿里手册整理出了适合我们的命名规范~

1. 不要使用拼音来命名，beijing alibaba youku 等国际通用名称例外。
   拼音容易引发歧义~
   getJiaGe();  getDaZhePrice(); 既不美观，也不直观。
2. 类名、方法名、变量名使用驼峰命名法。
3. 常量名全部使用大写，单词之间使用下划线分割，表达完整语义。
4. 要见其名知其意，抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类以测试的类名称开始，以Test结尾。
5. 包名统一用小写，点分隔符之间只有一个自然语义的英语单词。包名单数，类名可以使用复数。
6. 缩写要慎重，避免因为缩写导致代码可读性降低。
7. 如果模块、接口、类、方法使用了设计模式，要在命名上体现出来。
    OrderFactory LoginProxy ResourceObserver
8. Service/Dao命名规约，获取单个对象的方法get前缀；获取多个对象的方法list前缀，复数结尾；获取统计值的方法count前缀；插入方法save/insert前缀；删除方法remove/delete前缀；修改方法update前缀。