代码走读
代码检查方式
开发人员之间随机的互相阅读代码,检查其编写正确与否的代码检查方式。
内容简介
代码走读根据目的的不同,可以分为四个层次:
1、检查是否符合编程规范;
2、寻找编译器中的设计陷阱;
3、快速理解源代码,找出流程设计中的问题;
4、对原有代码的重构。
检查是否符合编程规范
编程规范融合并提炼了许多人多年开发编程语言程序积累下来的成熟经验,帮助编程者形成良好的编程风格,提高源程序的可读性和可维护性,降低出错的机会,迅速跨入业已存在的且具有相当高度的技术层次,并能够为提高代码的复用性提供积极的参考。
找编译器中的设计陷阱
术语“陷阱”的发展历史并不明确,而且它有多种定义方法。本文定义为编程和设计过程中常见的和可防止的问题,能顺利通过编译,没有任何警告和错误信息,而且计算机严格按照作者写明的代码执行,但是结果却不是作者期望的。许多IT人士都知道,市场上有很多新的编译器,它们可以捕获大部分程序错误,但遗憾的是,仍有许多错误是编译器不能发现的。打个比方,拼写检查程序是用来查找拼写错误的,但是,如果单词DOG被错误地写为CAT,您能指出单词CAT(实际是DOG)中的拼写错误吗?很显然,不能。因为这个单词可顺利通过拼写检查程序。这里描述的陷阱所包括的范围广泛,从较容易的语法问题,基本设计缺陷,到完全错误的行为。利用正确的使用方法来说明这些常见的误解和误用,可以防止编程者出现类似的问题,并防止新一代程序员重复过去的错误。
快速理解源代码,找出流程设计中的问题
无论是沟通程序的操作,还是将知识存储为可执行的形式,软件的源代码都是最终的介质。我们可以将源代码编译成可执行程序,也可以阅读代码来了解程序的功能及其工作方式,还可以修改源代码来改变程序的功能。大多数编程课程和书籍都将重点放到如何从零开始编写程序上。然而,在软件系统的工作投入中,40%~70%是用在系统首次编写完整之后,这些工作一定涉及到阅读、理解、以及修改最初的代码。另外,遗留代码持续不断、不可避免的累积;对软件重用的强调;软件行业中人员的高流动性;同时,开放源代码开发工作和协同开发过程(包括外包、代码走查和极限编程)日益重要,使得代码阅读成为当今软件工程师的一项基本功能。此外,阅读实际的、编写良好的代码,可以更加深入地了解如何改造与编写重要的系统,仅仅编写小型的程序学不到这种能力。有时,阅读代码是一件不得不去做的事,比如:为了修复、检查或改进现存的代码,都必须去阅读相关的代码。有些时候,阅读代码也许是为了了解程序是如何工作的,对于任何能够“打开盖子”的事务,作为工程技术人员,我们总是倾向于分析一下它的内部结果。您阅读代码可能是想提取可供重用的材料,或者仅仅是出于个人兴趣,将代码作为一种文献。每种原因的代码阅读都有自己的一套技术,强调不同方面的技能。代码走读中的阅读源代码强调的是通过快速理解源代码,找出流程设计中的问题这个目的。
对原有代码的重构
重构的含义是:在不破坏可观察功能的前提下,借由搬移、提炼、打散、凝聚……,改善事务的体质、强化当前的可读性、为将来的扩充性和维护性做准备、乃至于在过程中找出潜在的“臭虫”,就成了大受欢迎的稳步前进的良方;
单元测试
只有快速理解了源代码才可以完成单元测试,或者说快速理解源代码是完成单元测试的前提;利用单元测试可以帮助更好地重构;代码走读发现的问题比单元测试发现的更多、更快和更早;单元测试发现不了不满足编程规范的问题
方法介绍
形式上可以遵从同行评审的结构化的正规检视、走查、单人复审等;人工走读时,检查单可以按照头脑风暴、亲和图、鱼骨图方法形成系统化的检查树和处理机制;工具走读可以借助一些商用的测试工具和自己开发的辅助工具进行走读。
同行评审
同行评审是一种比较偏管理的方法,评审的材料可以包括文档和代码,对于代码的同行评审就是代码走读,本文讲的代码走读偏重于技术层面的方法,两者只有有效地结合才能更大地发挥它们的威力。
参考资料
最新修订时间:2024-05-21 14:40
目录
概述
内容简介
参考资料