麻省理工18年春软件构造课程阅读04“代码评审” 1

【代码评审】是一种重要的软件开发实践，旨在提升代码质量和程序员的技能水平。它涉及对他人编写的代码进行系统性的审查，类似于学术论文的同行评审。主要目标包括发现和修复现有及潜在的错误，评估代码的可读性和是否遵循项目特定的编程规范。代码评审在开源项目，如Apache和Mozilla，以及工业界，特别是像Google这样的大型公司中广泛实施。在Google，代码必须经过另一位程序员的审批才能被合并。 在进行代码评审时，遵循良好的编码风格是关键。虽然具体的风格规定可能因公司或项目而异，比如关于缩进、括号对齐等细节可能会引发激烈的争论，但保持一致性至关重要。例如，推荐遵循如Google Java Style的行业标准，它强调在关键字后留空格，函数调用后不留空格，以及使用花括号来增加代码的可读性。然而，对于花括号的放置风格，个人喜好可能会有所不同，重要的是在选择一种风格后保持一致，并尊重项目已有的风格指南。 在课程中，除了代码风格，还将讨论与目标紧密相关的代码原则，如避免bug、提高可读性和可维护性。这些原则超越了简单的格式规范，涉及到更深层次的编程实践。例如，"难闻的"代码（bad smell）可能是指那些难以理解或可能导致错误的代码段，如冗余的条件检查或复杂的逻辑结构。在给定的例子中，一个用于计算一年中的天数的函数使用了多个if-else语句，这不仅使代码难以阅读，而且可能隐藏错误。更有效的做法可能是使用查找表或嵌套循环来简化此类计算。 代码评审不仅关注代码风格，还包括检查代码是否符合规格说明，是否正确实现了抽象数据类型，以及是否考虑到并发编程和线程安全问题。随着课程的深入，将涵盖更多此类主题，以帮助学生全面了解如何进行有效的代码评审，从而提升整个软件开发过程的质量和效率。