知识卡片

普通读书笔记卡 · 4255

代码质量评价的两个维度

理解等级:高级

Bjarne Stroustrup、Grady Booch、Michael Feathers等人给出的“逻辑清晰”“整洁简单”“没有明显需要改善之处”等定义都指向重要品质,但直接用于评判具体代码时仍缺乏操作性,尤其对尚未形成判断力的新人。

代码有两个“读者”:计算机和程序员。评价因此至少包含两个维度:一是人能否理解、修改和维护;二是代码在机器上是否正确、健壮且有效率。前一维带有主观性,同一段代码可能得到不同判断;这种判断会随经验增长,也需要持续思考、学习和批判。团队不能只重复抽象原则,还要把原则转成可复查的动作,例如检查命名能否表达职责、依赖是否必要、异常路径是否明确、修改是否影响既有行为,并通过评审积累共同尺度。

这张卡片看不懂?

已有反馈 · 0 条

    还没有人提交反馈。

    原书出处

    参考来源

    - 位置:《高可用架构(第1卷)》第5章《运维保障》“5.6 系统运维之评价代码优劣的方法”(源文件:_epub-src/OEBPS/Text/Chapter5_6_1.xhtml,段落序号:2,3;从0计) - 结论依据:原文说明本节目标是更高效、客观地评价代码,并以新人不了解好代码的样子说明操作性标准的必要性。 - 原始内容:虽然刚毕业的同学对于代码质量都很用心,但最终呈现出来的质量仍然没能达到“十分优秀”的程度。究其原因,主要是不了解好的代码“应该”是什么样的。 - 位置:《高可用架构(第1卷)》第5章《运维保障》"5.6 系统运维之评价代码优劣的方法"节,"5.6.1 什么是好代码"(源文件:_epub-src/OEBPS/Text/Chapter5_6_2.xhtml) - 结论依据:原文引用多位权威的好代码定义后说明"看起来似乎说得都很有道理,可是实际评判的时候却难以参考……在某种意义上代码质量的评价标准有点类似于文学作品的评价……但代码和小说还是有些不一样,它实际存在2个读者:计算机和程序员……所以对于代码质量的定义我需要于从2个维度分析:主观的,被人类理解的部分;还有客观的,在计算机里运行的状况",直接支撑本卡片结论。 - 原始内容:但代码和小说还是有些不一样,它实际存在2个读者:计算机和程序员。就像上一节里说的,即使所有程序员都看不懂这段代码,它也是可以被计算机理解并运行的。 - 位置:《高可用架构(第1卷)》第5章《运维保障》“5.6.2 结语”(源文件:_epub-src/OEBPS/Text/Chapter5_6_3.xhtml,段落序号:1,2;从0计) - 结论依据:原文承认部分评价手段主观性很强,同时指出评价准确度会随经验增长,且需要保持思考、学习和批判。 - 原始内容:虽然每个人对于代码质量评价的倾向都不一样,但是总体来说评价代码质量的能力可以被比作程序员的“品味”,评价的准确度会随着自身经验的增加而增长。