<读书笔记>(模块层面)BMS-10: 写整洁的代码

原则: 写整洁的代码.

每当有机会去修改或增加功能的时候, 实际都可以对该部分代码进行继续优化或重构.

下面介绍 7 个原则:

1. 让代码在代码单元层面上符合可维护性要求
2. 让代码自解释
3. 清理掉注释了的代码
4. 清理掉无用代码(Dead Code)
5. 清理长的标识符
6. 清理魔法常数
7. 清理差劲的错误处理

第一点要求代码在代码单元层面上保持可维护, 即需要保证:

• 写短小的代码单元(15行内)
• 写简单的代码单元(环路复杂度在5以内)
• 写拥有简单接口的代码单元(参数个数不超过4个)
• 清理重复代码(可检测的只有复制粘贴型重复, 逻辑重复需要人工检查)

遇到代码中有不符合要求的情况时, 需要对代码进行重构.

一般来说, 在代码中出现的单行注释都是不好的代码的预兆. 因为这有可能表示在一个代码单元中做了多件事情. 而最好的代码是自解释的, 即这行代码在这个代码单元中, 这行代码整体上就可以被解释, 然后一个代码单元自己又可以自解释, 这样在任意调用位置都能够保证代码中不存在内部注释.

无用的代码指的是那些不再被调用的代码, 或者是调用了, 但其结果不再被使用到的代码. 另外还有如下三种类型的无用代码:

• 方法中永远无法被执行到的代码
• 无用的私有方法
• 在注释中的演示代码

对于标识符而言, 避免长标识符, 一般的做法是在团队内部形成一套正式的标识符命名规范, 或者是一套非正式的, 能够保证稳定实施的, 根据业务领域确定的命名规则.
但标识符的命名绝非易事, 有时可能要经过几次迭代, 才能确定这个方法的正确命名.

不过总的原则是, 应避免使用长标识符. 但具体多长的限制则应根据具体情况确定.

当遇到魔法数字的时候, 应将其替换为常量进行处理.