软件工程中的演练

代码走查简介

代码走查（Code Walkthrough）技术体现了一种非正式的代码分析方法。在模块成功编译并消除所有语法错误后，一群人会聚集在一起审查程序代码并解决疑问。如果代码作者无法回答某些问题，则会将这些问题记录下来以便后续解决。开发团队的某些成员会提前收到代码，以便在走查会议之前进行审查并理解其细节。每位参与者都会选择特定的测试用例并手动模拟代码的执行。代码走查的主要目标是识别代码中的算法和逻辑错误。

代码走查的运作方式

代码走查涉及文档的作者，由作者组织评审过程，引导参与者思考和讨论。目的是促进相互理解并收集反馈。当非软件开发文档专家（例如来自不相关领域的人员）在场时，这种方法尤其有利。作者会仔细地一步步解释文档内容，最终得出修订或收集信息的结论。

在走查过程中，大部分准备工作由作者完成。来自不同部门和背景的参与者，根据他们的角色选择，无需提前深入研究文档。会议的结构化性质有助于大量人员的参与，每个人都能对文档内容提供广泛的视角。这种包容性也起到了教育作用。当听众由不同技能和学科的人员组成时，可以确保在代码走查过程中不会忽略重要的缺陷。这种方法对于更高层次的文档（如需求规范和架构记录）尤其有效。

代码走查的目标

代码走查的具体目标取决于其在文档创建中的目的。通常，可以应用以下目标：

吸引利益相关者：将文档呈现给软件内外的利益相关者，以收集与文档主题相关的见解。

建立共同理解：促进所有参与者对文档内容的相互理解。

探索与评估：深入探讨和评估文档内容，以评估其连贯性和有效性。

验证解决方案：审查和讨论拟议解决方案的有效性以及替代方案的可行性，以达成共识。

代码走查的指导原则

最佳团队规模：代码走查团队的组成不宜过大也不宜过小。理想情况下，应包含三到七名成员。

以错误为中心的讨论：讨论应侧重于识别错误，而不是立即进行修正。

管理层参与：为了促进合作并减轻工程师的潜在评估顾虑，建议管理层不要参加代码走查会议。

代码走查的独特之处

作者主导的会议：代码走查会议由文档的作者或作者组织，有时由指定的记录员协助。

验证技术：内容验证可能涉及场景模拟和试运行。

可选的会前准备：评审者可以选择在会前进行单独的准备工作。

优点

以下是一些优点

多元化的视角：走查带来了多种观点。

作者主导的管理：代码走查会议由文档创建者在分析阶段与团队成员合作进行监督。

多样化的会议形式：走查中的会议，无论正式还是非正式，都提供了灵活性。

知识赋能：代码走查的主要目标是传播被审查文档内容方面的知识，增强团队成员的理解。

提高意识和错误检测：代码走查提高了对文档内容的认识，并促进了错误的发现。

缺点

以下是一些缺点

有限的完整性：讨论的全面性仅限于团队提问的领域。

缺乏多样性：在代码走查中，作者主要引导过程，导致缺乏多样化的视角，因为其他人主要是澄清口头解释与所采取行动之间的对应关系。

肤浅的探索：一个缺点是，可以看到缺乏深度。

时间和地域限制：当参与者分布在不同时区时，会议可能会非常耗时且难以管理。

代码走查工具

有许多用于代码走查的工具可供选择。本节将讨论其中的一些工具。

Review Board：这是一个基于 Web 的工具，便于进行代码走查。作为一个开源解决方案，它根据特定要求支持提交前和提交后代码审查。

Crucible：另一个值得推荐的代码走查审查工具，Crucible 支持跨版本控制系统的代码审查、变更讨论和错误识别。

Collaborator：这是另一个用于代码走查审查的工具，Collaborator 使团队成员能够审查代码和设计文档。

CodeScene：该工具超越了传统的静态代码分析，允许用户从行为层面深入代码审查。它进行行为代码分析。