养成良好的代码书写习惯

前言

计算机巨匠 Donald Kunth(《计算机程序设计的艺术》系列作者)有一句名言: 程序是写给人看的,只是偶尔让机器执行一下

正文

  1. 类要写好注释
  2. 方法要写好注释
  3. 变量名不规范,不知所云。变量命名的首要规则就是” 见名识义“
  4. 拒绝字面值,也称之为”魔数“(magic number),所有字面值统统拿出来放到代码的最前面定义成常量
  5. 过度膨胀的类。设计模式六大原则里有个 单一职责原则
  6. 重复的代码。《重构》一书提到过代码的bad smell(坏味道),其中之一就是duplicated code。重复的代码意味着,如果需求变化,那么需要多处修改。而更坏的消息便是,在一个有5千行代码的类里多处修改。
  7. 过长的形参列表。方法的形参列表过长,不仅难以阅读,调用起来也觉得麻烦。超过3个就定义成一个类
  8. 过长的的方法。同类一样,方法也要职责单一,不宜过长。相信大家都有这样的认识:方法越长,越难以理解。
  9. 日志被吃掉。这个虽然无关代码风格,但是对线上排查问题极为重要。多次排查线上问题时,发现日志没有输出完整,甚至根本没有输出。
    做好catch的捕捉,一定要把日志输出出来,以栈的形式输出
  10. 所有的接收参数,如要取值一定要做非空判断,否则容易出现空指针

积累

今天搭建了sonar进行代码检测,在此记录修改总结

  1. 取值时需要先判断对象是否非空
  2. 使用BigDecimal.valueof()代替new BigDecimal
  3. 两个都是Integer比较相等用equals()

猜你喜欢

转载自blog.csdn.net/weixin_42119415/article/details/113589546