代码审查是保证软件质量的有效方法,而其所以有效,是因为代码审查的判断标准是依据以下七个设计原理:
简单性原理就是追求简单。它要求程序员能够以最简单的逻辑编写代码,重视局部的完整性,而不是复杂的整体关联性。 代码审查人员应当关注被审查代码是否足够简洁,去除了复杂的结构。
同构原理就是要求程序员必须规范地编写代码, 因为不同的东西往往容易产生bug。 代码审查人员应当关注被审查代码是否遵循同构原理,相同的逻辑是否采用同样的处理。
遵循对称原理的代码讲究形式上的对称,比如有上就有下,有左就有右,有主动就有被动。这样的代码可读性好,能够帮助读代码的人推测后面的代码,提高其理解代码的速度。 代码审查人员应当关注被审查代码中出现“条件”的时候,是否同时存在“反条件”;条件与反条件是否统一;代码中的命名是否也具备对称性,如使用set/get、start/stop、begin/end和push/pop等成对的词语。
层次原理就是智代码在结构上讲究层次,不同层次各司其职,同种处理不跨越多个层次。比如执行了获取资源的处理,那么释放资源的处理就要在相同的层次进行。 这样的代码可读性很高,能够帮助程序员表达编码意图,降低bug发生的概率。 代码审查人员应当关注被审查代码中相互关联紧密的逻辑是否处于同一层次。
线性原理就是让处理流程尽量走直线。两点之间,直线最短。遵循线性原理的代码,它的结构就会非常简单,代码的可读性很高。 代码审查人员应当关注被审查代码中条件语句和循环语句的必要性。
清晰原理就是代码逻辑必须清晰,这样的代码能清楚证明自身的正确性,能够让人一眼就能判断出代码有没有问题。 代码审查人员应当关注被审查代码是否直观易懂,容易理解且不存在歧义。
安全原理就要采用相对安全的方法来对具有不确定性的、模糊的部分进行设计和编程。比如即便某个if语句一定成立,我们也要考虑else语句的情况;即便某个case语句一定成立,我们也要考虑default语句的情况;即便某个变量不可能为空,我们也要检查该变量是否为NULL。 这样可以确保软件在任何情况下都能安全运行。 代码审查人员应当关注被审查代码有没有考虑那些不可能的条件是否能够实现。 你的代码审查遵循了这些判断标准吗? 这正是: 代码审查有标准,七个原理应遵循 参考书目:编程的原则:改善代码质量的101个方法,作者:上田勋,译者:支鹏浩,出版社:人民邮电出版社 |
|