一、结构化表达

What is it:现象、成果
一坨代码?
How to do:方法、措施
代码规约?
Why:目的、理念
为什么代码规约很重要?

通过现象看本质,最终的目的是共同达到 why 的理念。通过代码规约,实现自己技术能力的上升,沟通的上升。

二、编写可读代码的艺术

1. 表面层次的改进
2. 简化循环和逻辑
3. 重新组织代码

三、阿里规范

(一) 命名风格
  • 第3点 DTO,参考使用我们以前的方式 Dto
  • 第6点 抽象类是否都强制使用 Abstract 或 Base 开头
  • 第8点 布尔类型,不要加 is 前缀,可以参考用 should、has、can
  • 第9点 包名统一用单数? 包名只有一个语义?
  • 第15点 枚举类 建议带上 Enum 后缀?
  • 第16点 获取多个对象的方法用list 做前缀,复数形式结尾。领域模型 命名?
(二) 常量定义
  • 第一点 不允许任何魔法值 直接出现在代码里?
  • 第三点 按照常量功能进行归类,分开维护
  • 第四点 需要讨论,能否做到如此规范?
(三) 代码格式
  • 第三点 保留值与空格

    1
    2
    3
    4
    5
    if () {

    }
    int a = 1;
    method(String a, String b)
  • 第六点 注释// 空格

  • 第八点 参数前空格

  • 第10点 总行数 不超过80行

  • 乐观锁的重试次数不得小于 3 次