源代码阅读技巧1

摘要：本文从阅读源代码的目的和意义开始，主要介绍了怎样阅读别人的源代码，列举了阅读开源代码的例子，以及阅读开源代码工具和阅读源代码的技巧。
引言
大家在软件开发过程中，在加入一个团队后或多或少都会接触到原来的源代码，要不是在原有基础上继续开发或者维护，或者在原有代码上改进优化进行新产品开发，或者在开发一个新模块的时后需要借鉴下类似的开源软件源代码，接下来我讲谈谈对源代码的处理问题。
1阅读源代码的目的和意义
1.1阅读源代码的目的
阅读别人的代码作为软件开发人员来说是一件经常要做的事情。
第一个是在学习新的编程语言的时候通过阅读别人的代码是一个最好的学习方法，也是积累编程经验和技巧的过程。如果你有机会阅读一些操作系统的代码会帮助你理解一些基本的原理。
第二个就是在你作为一个质量保证人员或一个小领导的时候；如果你要做白盒测试的时候没有阅读代码的能力是不能完成相应的任务。
第三个就是如果你中途接手一个项目的时候或给一个项目做代码维护和优化的时候是要有阅读代码的能力的。
1.2.阅读源代码意义
因为源代码的处理在程序员的软件开发中不可避免，那么在阅读源代码中有哪些意义呢？
第一个意义是可以学习到很多编程的方法和技巧。看好的源代码，对于提高自己的编程水平，比自己写源代码的帮助更大。当然不是说不用自己写，而是说，自己写代码的同时，可以从别人写的好的源代码中间学习到更多的编程方法和技巧。
第二个意义是，可以提高自己把握大规模源代码的能力。一个比较大型的程序，往往都是经过了很多个版本很长的时间，有很多人参与开发，修正错误，添加功能而发展起来的。所以往往源代码的规模都比较大，少则10-100多k, 多的有好几十个MB. 在阅读大量源代码的时候，能够提高自己对大的软件的把握能力，快速了解脉络，熟悉细节，不仅仅是编程技巧，还能在程序的架构，设计方面提高自己的能力。在设计模式的书中就提到，设计模式并不是一本教材，不是教你如何去编程序，而是把平时编程中一些固定的模式记录下来，加以不断的测试和改进，分发给广大程序员的一些经验之谈。
第三个意义，就是获得一些好的思想。比如有很多人在开始一个软件项目之前都喜欢到sourceforge.net上去找一下，是否有人以前做过相同或者相似的软件，如果有，则拿下来读一读，可以使自己对这个软件项目有更多更深的认识。
2怎样阅读别人的源代码
2．1收集所有可能收集的材料
阅读代码要做的第一件事情是收集所有和项目相关的资料。比如你要做一个项目的维护和优化，那么你首先要搞明白项目做什么用的，那么调研、需求分析文档、概要设计文档、详细设计文档、测试文档、使用手册都是你要最先搞到手的。如果你是为了学习那么尽量收集和你的学习有关的资料，比如你想学习linux的文件系统的代码，那最好要找到linux的使用手册、以及文件系统设计的方法、数据结构的说明。这些资料在网上或书店里都可以找到。
材料的种类分为几种类型：
a、基础资料。
比如你阅读turbo c2的源代码你要有turbo c2的函数手册，使用手册等专业书籍；java 的话不但要有函数手册，还要有类库函数手册。这些资料都是你的基础资料。另外你要有一些关于uml的资料可以作为查询手册也是一个不错的选择。
b、和程序相关的专业资料。
每一个程序都是和相关行业相关的。比如我阅读过一个关于气象分析方面的代码，因为里边用到了一个复杂的数据转换公式，所以不得不把自己的大学时候课本找出来来复习一下高等数学的内容。如果你想阅读linux的文件管理的代码，那么找一本讲解linux文件系统的书对你的帮助会很大。
c、相关行业的文档资料
这一部分的资料分为两种，一个相关行业的资料，比如你要阅读一个税务系统的代码那么有一些财务/税务系统的专业资料和国家的相关的法律、法规的资料是必不可少的。
2．2留备份,构造可运行的环境
了解基础知识，不要上来就阅读代码，打好基础可以做到事半功倍的效果，代码拿到手之后的第一件事情是先做备份，最好是刻在一个光盘上，同时上传在版本控制CVS、SVN或GIT库，在代码阅读的时候一点不动代码是很困难的一件事情，特别是你要做一些修改性或增强性维护的时候。而一旦做修改就可能发生问题，到时候要恢复是经常发生的事情，如果你不能很好的使用版本控制软件那么先留一个备份是一个最起码的要求了。
在做完备份之后最好给自己构造一个可运行的环境，当然可能会很麻烦，但可运行代码和不可运行的代码阅读起来难度会差很多的。所以多用一点时间搭建一个环境是很值得的，而且我们阅读代码主要是为了修改其中的问题或做移植操作。不能运行的代码除了可以学到一些技术以外，用处有限。
2.3 找阅读开始的地方
做什么事情都要知道从那里开始，读程序也不例外。在c语言里,首先要找到main()函数，然后逐层去阅读，其他的程序无论是VC、delphi都要首先找到程序头，否则你是很难分析清楚程序的层次关系。
2.4分层次阅读
在阅读代码的时候不要一头就扎下去，这样往往容易只见树木不见森林，阅读代码比较好的方法有一点像二叉树的广度优先的遍历。在程序主体一般会比较简单，调用的函数会比较少，根据函数的名字以及层次关系一般可以确定每一个函数的大致用途，将你的理解作为注解写在这些函数的边上。当然很难一次就将全部注解都写正确，有时候甚至可能是你猜测的结果，不过没有关系这些注解在阅读过程是不断修正的，直到你全部理解了代码为止。一般来说采用逐层阅读的方法可以是你系统的理解保持在一个正确的方向上。避免一下子扎入到细节的问题上。在分层次阅读的时候要注意一个问题，就是将系统的函数和开发人员编写代码区分开。在c, c++，java ,delphi中都有自己的系统函数，不要去阅读这些系统函数，除非你要学习他们的编程方法，否则只会浪费你的时间。将系统函数表示出来，注明它们的作用即可，区分系统函数和自编函数有几个方法，一个是系统函数的编程风格一般会比较好，而自编的函数的编程风格一般比较会比较差。从变量名、行之间的缩进、注解等方面一般可以分辨出来，另外一个是像DELPHI会在你编程的时候给你生成一大堆文件出来，其中有很多文件是你用不到了，可以根据文件名来区分一下时候是系统函数，最后如果你实在确定不了，那就用开发系统的帮助系统去查一下函数名，对一下参数等来确定即可。
2.5写注解
写注解是在阅读代码中最重要的一个步骤，在我们阅读的源代码一般来说是我们不熟悉的系统,阅读别人的代码一般会有几个问题：
a、搞明白别人的编程思想不是一件很容易的事情，即使你知道这段程序的思路的时候也是一样。
b、阅读代码的时候代码量一般会比较大，如果不及时写注解往往会造成读明白了后边忘了前边的现象。
c、阅读代码的时候难免会出现理解错误，如果没有及时的写注解很难及时的发现这些错误。
d、不写注解有时候你发生你很难确定一个函数你时候阅读过，它的功能是什么，经常会发生重复阅读、理解的现象。
一些写注解的基本方法：
a、猜测的去写，刚开始阅读一个代码的时候，你很难一下子就确定所有的函数的功能，不妨采用采用猜测的方法去写注解，根据函数的名字、位置写一个大致的注解，当然一般会有错误，但你的注解实际是不但调整的，直到最后你理解了全部代码。
b、按功能去写，别把注解写成语法说明书，千万别看到fopen就写打开文件，看到fread就写读数据，这样的注解一点用处都没有，而应该写在此处打开参数配置文件（****.dat）读出系统初始化参数……，这样才是有用的注解。
c、在写注解的时候另外要注意的一个问题是分清楚系统自动生成的代码和用户自己开发的代码，一般来说没有必要给系统自动生成的代码写注解。像delphi的代码，我们往往要自己编写一些自己的代码段，还要对一些系统自动生成的代码段进行修改，这些代码在阅读过程是要写注解的，但有一些没有修改过的自动生成的代码就没有必要写注解了。
d、在主要代码段要写较为详细的注解。有一些函数或类在程序中起关键的作用，那么要写比较详细的注解。这样对你理解代码有很大的帮助。
e、对你理解起来比较困难的地方要写详细的注解，在这些地方往往会有一些编程的技巧。不理解这些编程技巧对你以后的理解或移植会有问题。
f、写中文注解。如果你的英文足够的好，不用看这条了，但很多的人英文实在不怎么样，那就写中文注解吧，我们写注解是为了加快自己的理解速度。中文在大多数的时候比英文更适应中国人。与其写一些谁也看不懂的英文注解还不如不写。
2.6重复阅读
一次就可以将所有的代码都阅读明白的人是没有的。至少我还没有遇到过。反复的去阅读同一段代码有助于代码的理解。一般来说，在第一次阅读代码的时候你可以跳过很多一时不明白的代码段，只写一些简单的注解，在以后的重复阅读过程用，你对代码的理解会比上一次理解的更深刻，这样你可以修改那些注解错误的地方和上一次没有理解的对方。一般来说，对代码阅读3，4次基本可以理解代码的含义和作用。
2.7运行并修改代码
如果你的代码是可运行的，那么先让它运行起来，用单步跟踪的方法来阅读代码，会提高你的代码理解速度。通过看中间变量了解代码的含义,而且对以后的修改会提供很大的帮助。

用自己的代码代替原有代码，看效果，但在之前要保留源代码。600行的一个函数，阅读起来很困难，编程的人不是一个好的习惯。在阅读这个代码的时候将代码进行修改，变成了14个函数。每一个大约是40-50 行左右。

原文转至 http://blog.csdn.net/goodfriends2007/article/details/6881883。