阅读代码的几点建议

阅读代码的几点建议

增加编程技巧的一种方式就是阅读好的程序，一些好的代码的文档丰富，说明详细，因此代码阅读比较快，但是并非所有代码都那样的，一些代码的注释不多，而且语法复杂，继承多态化比较多，因此看这样的代码的时候要注意策略。最好的看待的方式是什么？阅读那些比较庞大的，结构不清晰，多人维护的代码的最佳的方式是什么？

构建并运行测试代码　Build and Run the Program

能够运行代码病观察外部行为对于理解内部的运转十分有用。程序的说明文档很重要。对应的算法的paper很重要，但是文档无法全面的说明内部情况。因此自己跑一下程序可以帮助自己弄清外部的依赖，使用编译器，链接选项。

理解高层逻辑　Find the High-Level Logic

从程序的入口进入代码，如main in cpp,c,java etc。ros中找到节点,launch文件等。明确程序如何初始化，做了哪些事，如何结束。程序的主循环中发生了什么？找到程序的结束条件，正常的退出和异常的退出情况。

很多面向对象的时间驱动的程序设计没有main函数,如mfc等等。这种情况下仍然有很多技巧。mfc中程序的构造函数和初始化函数开始。另外注意QT中的槽和信号量。嵌入式系统中的中断函数，ROS中的各种回调函数等等，抓住使用的系统的运行特点，明白代码的调用顺序就比较容易理解代码的逻辑了。事件驱动的设计一定要去关注各类的构造函数，这样就会明确回调函数在哪里，发生事件之后，PC（程序指针）跳到了哪里执行。

画流程图　Draw Some Flowcharts

虽然流程图是一个恐怖的设计工具，但是他们对于分析代码是十分有用的。一个人没有办法记住所有的东西，所以在阅读代码的时候很有必要记录关键的步骤和状态，注意确保画出了程序的各个分支。

测试库调用　Examine Library Calls

如果一个程序使用外部库，测试库调用，并阅读库的说明文档。

查找关键词　Search for Key Words

善于使用开发环境的搜索功能(grep)，这样可以找到源码中的关键词，这样可以联系到你所知道的。例如你想直到程序中关于文件的操作是从哪里开始，可以搜索程序中的file或者open关键字，你可能得到很多item，没关系，那不是一件坏事，总比什么都没有好得多。

Leverage the Power of Code Comprehension Tools

一些可用的技巧是好的文本搜索工具，对于面向对象的程序设计，允许问一问自己以下的几个问题
1. 这个方法是谁调用的
2. 这个接口是那个类实现的，子类继承自谁
3. 这个类的父类是谁
4. 这个变量实体是那个类实例创建，保持，传递参数，返回？
5. 这个方法的重载那个父类的方法
6. 这个类的方法可能在哪里调用，通过一个基类还是接口。

References: “Comprehension and Visualisation of Object-Oriented Code for Inspections” http://www.cis.strath.ac.uk/research/efocs/abstracts.html#EFoCS-33-98 section 5.

整理这个代码Clean Up the Code

对于很久以前写的代码想要重新熟悉起来，或者分别别人写的怎么办？一个old的编写技巧就是把他编辑为一个自己喜欢的方式。这个叫做主动阅读。这样比只阅读这个代码理解的要深入的多。
把代码重新格式化，调整空格，给代码做好注释，修改拼写错误，使得他代码符合编码标准。

refer

1. http://wiki.c2.com/?TipsForReadingCode