分享

【编码】提高代码变坏的敏感度

 东北十三少 2020-10-16

软件缺陷的修复有个规律:越早发现的缺陷,修复的代价越小。所以,这也是优秀的软件工程师追求的目标。

从“零缺陷”和“六西格玛”的核心理论来看,预防比找错重要的多。而要预防,优秀的软件工程师不仅是要从经验教训库中汲取历史经验,还应该提高代码变坏的敏感度。

代码变坏,就是代码的坏味道。代码一旦出现坏味道,就意味着代码可能潜伏着很多缺陷,这些潜在的风险就有可能在未来的某一天爆发,而修复这些缺陷的代价将会非常巨大。

所以预防代码缺陷,就要提高对代码坏味道的敏感度。

代码的坏味道可以分为代码的可读性差、可维护性差、可测性差等几个方面。

1)代码可读性差的坏味道包括:不恰当的信息、冗余的注释等。

2)代码可维护性差的坏味道包括:注释掉的代码、死函数、晦涩的意图等。

3)代码可测性差的坏味道包括:人为耦合、不正确的边界行为等。

很多组织都已经制定了很好的编码规范。如果这些编码规范都能用于实践,那么代码的很多坏味道就可能不会出现。可是,实际编码实践的过程中,这些编码规范经常没有得到很好的执行。

这里不去探讨不能很好执行的原因,而是从代码坏味道预防来讲,这是因为软件工程师缺少代码变坏的敏感度。

如何培养对代码坏味道的敏感度?

首先要培养代码缺陷预防的意识。预防缺陷,不仅为了避免将来修复缺陷将要付出的巨大代价,更可以打造出高质量的代码,零缺陷的代码。

从以往的代码审查和测试中汲取经验教训。这些代码的坏味道终将以各种缺陷的形式显现。从缺陷库中的各种缺陷回推坏代码,这样会对代码的坏味道增加直观的理解。

不断完善编码规范。《代码的整洁之道》一书中有很多好的建议,包括命名、注释、函数、格式、类、数据结构、边界、错误处理等内容,可以将之与自己的实践经验结合,不断扩充和完善。

持续做好代码审查。除了软件工程师自己有意识地应用编码规范,预防代码的坏味道,还需要组织能够持续地推行代码审查活动,并且在代码审查活动中切实地关注编码规范的执行情况。

只要有了缺陷预防意识,软件工程师就能不断摆脱代码的坏味道,不断提高自己的代码质量,终有一天会成为软件大师。

微信号:IdeaofSE

    转藏 分享 献花(0

    0条评论

    发表

    请遵守用户 评论公约

    类似文章 更多