目标:
1.能够阅读和理解重要软件的代码;
2.领会许多重要的软件开发概念;
3.知道如何探索大型的代码体;
4.拥有大多数重要的高级、低级编程语言的阅读能力;
5.认识到现实软件项目的错综复杂性;
1.导论
1.1 为什么要阅读代码
(1)修复,检查,改进现有的代码;
(2)发现它的的运作机理;
(3)提取可以重复利用的资源;
1.1.1 将代码作为文献阅读
低品质代码的特征:
1.编程风格不一样;
2.结构不必要的复杂或难以理解;
3.明显的逻辑错误或疏忽;
4.过度使用不可移植的构造;
5.缺乏维护;
低品质的代码不需要再阅读浪费时间,因为现在高品质的开源代码实在太多;
没有最好的代码,只有更好的代码。代码的结构和功能都是在不断的改进;
有选择的阅读代码,并且要有自己的目标;
要十分主要代码的非功能性徐需求,这些需求可能会导致特殊的实现风格;(可移植性,时间或空间效率,易读性,迷惑性需求)
开始从一些小型的代码开始阅读,熟悉了解之后加以改进;
1.1.2 以代码为范例(特定的功能是如何实现的)
阅读相关文档(任何形式,即使是用户手册也要仔细阅读)
快读找到目标代码(任何方法和策略,重点是要快)
研究分析,忽略掉不相关的部分(切片)
1.1.3 维护 (修复)
使用工具将问题进行细化
eg:编译器给出的警告或者错误提示,在代码中加入打印语句。
1.1.4 演进 (增加新的功能)
对所分析的代码的范围有所选择,可能是实现的一小部分,也可能是一两个文件
定位到感兴趣的代码
单独了解各个特额定的部分
推断节选出的代码与其余代码的关系
增加新功能时,可以先找到实现相似类型的代码,以此为待实现功能的模板
修改一个已经存在的特性时:
1.定位到底层代码,从特性的功能描述定位到代码的实现
2.定位到相关代码开始理解实现,设计新的特性或增加新的功能,代码中与新代码交互的地方
重构:
1 一个正常工作系统做起,结束时仍能正常工作(一套测试用例)
2 主动寻找可改进的代码
1.1.5 重用 (可以重复利用的元件)
1.相关的部分难以理解,整个库直接使用
2.先检查代码,再手机可重复利用的代码
1.1.6 审查
功能性问题:
分析代码,发现逻辑或者功能上的错误,验证代码是否满足需求
非功能性问题:
1.开发规范或者风格
2.是否存在重构的可能
3.部分代码是否可以编写的更易懂,更高效
4.某些部分是否重用现存的库或组件
其他:
文件和目录结构,生成和配置过程,用户界面和系统的文档
1.2 如何阅读本书
1.2.6 大纲
第2章:两个完整的程序,分析如何工作,代码阅读策略,常见 C 语言控制结构,构建块,习惯用法和缺陷
第3章,第5章:C 语言高级
第4章:如何阅读代码,收录常用的数据结构
第6章:处理大型项目的代码
第7章:编码规范和约定
第8章:正式的文档
第9章:系统框架
第10章:代码阅读工具
第11章:代码阅读和代码理解技术
附录 A:代码
附录 B:格言
2.基本编程元素
2.1 一个完整的程序
用编译器对代码进行编译,检查产生的警告消息
int main(int argc, char ** argv)
public static void main (String argv[])
#fdefine STREQ {a,b} (*(a) == *(b) && strcmp((a), (b)) == 0)
检查代码时,一定要核实所有的程序控制路径使用的变量是否进行了初始化
检查输出结果是否正确
程序的标准输出重定向到文件失败的原因:
1.存储输出的设备可能没有剩余空间;
2.设备上分配给用户的空间可能耗尽;
3.进程对文件的写入可能超出进程或者系统文件大小的最大限制
4.输出设备上可能发生硬件错误;
5.文件描述符或与标准输出关联的流或许不能写入;
2.2 函数与全局变量
头文件,全局变量,函数声明
检查代码时,确保所用只用于单一文件的变量都声明为static
了解函数的功能:
1.猜,基于函数名;
2.阅读位于函数开始部分的注释;
3.分析如何使用该函数;
4.阅读函数体的代码;
5.查阅外部的程序文档;
从容易的部分开始,渐进式理解,来理解困难的代码