贺利坚-如何阅读代码(已阅加重点划)

      作为研发人员,阅读别人的代码是一件经常要做的事情。在学习编程语言的时候,也需要通过阅读代码理解语法和语言机制。通过阅读别人的代码,学到自己编写程序的本领,这也是一种极佳的学习方法。有很多公司给实习生的工作安排,就是阅读代码。通过读代码,可以掌握公司的业务,以及生产组织的方法。大学生常说缺乏实践经验,其实阅读程序也是一种积累编程经验的方法。

  写程序和写文章可以放在一起类比。写文章需要先从宏观入手,构思文章的结构;程序的结构设计好了,程序也差不多能写出来了。一篇好的文章需要各种句式和措辞的合理组合;写程序就是要熟练使用控制结构和语句。但凡文章写得好的人,一定看过很多别人写的文章;同样的道理,多看别人的程序,用心地去看,也可以提高自己写代码的能力。

  从20世纪90年代开始,开源运动为IT业界开创了一个崭新的世界。开源运动奉献出了一大批的优秀项目,为学习者在共享协议框架内免费使用。这为学习者提供了难得的直接观摩成熟项目的机会。甚至于,大学生在校期间就有机会自由加入到开源社区,参与到项目的开发中去。每年的暑假,也有一些组织提供让大学生短期参加开源项目的活动,使在校大学生获得产业一线的指导,获得在大企业实习的机会,当然,还有丰厚的报酬。

  阅读数万行开源软件项目的代码需要不少高级技巧,对初学者有些为时过早,这个可以作为翅膀长硬后的选项。不积跬步,无以致千里,在学习程序设计之初,要意识到读源代码对技术成长的重要意义,尝试从一些小段的代码入手,在阅读中找到有效的阅读程序的方法

  初学者阅读代码的来源,可以是教科书上的例题,也可以是一些案例集中的程序库,当然也可以是一些已经开发完成的小型项目

  阅读代码要采用先整体,后局部的方法。在阅读时一头就扎到细节中的做法不可取,容易只见树木不见森林。先对整个程序有个总体的认识,将有助于细节的把握。很多的程序在开始时都会提供注释,对整个程序进行说明,这也是编码规范的要求(编写程序时养成随手加注释的好习惯)。如果有注释的话,可以先读到程序的功能是什么,以及程序中主要算法的思想,这些将有助于从整体上把握程序。要先从整体上了解其中各个子程序(函数)的大致功能及调用关系,然后再细读其中的每一个函数。为找出各函数的调用关系,可以从程序执行的入口main()函数开始读,以此找出程序间相互调用、返回的路径。每个函数是程序中相对独立的模块,要先看整体的控制结构,再到具体的语句;先看出解决问题的整体方案,再发现其中的技巧。这种阅读程序的习惯,体现的也是自顶向下的思想,这和设计程序的方法是一致的,体现的就是一种专业的思维模式,在阅读中逐步深化这种思维方式。

  程序的三种控制结构分别是顺序、分支和循环。问初学者哪种结构最复杂时,往往回答是循环。的确,在学习程序设计中,用循环结构解决问题将不少人绕了个够呛。如果需要循环嵌套,那更是不得了的事。设计程序中要自顶向下地分析问题,阅读程序时也是优先成块的整体阅读。从这种角度,先能看到由顺序结构形成的大块,然后再关注用逻辑更为复杂的分支和循环描述的细节,体现出来的是对顺序结构的重视。从这个角度,简单的顺序结构竟包含着守拙中的极巧,体现的是“大道至简”。

  在编程时,在需要的地方写上注释是良好编码风格的要求。在阅读不熟悉的程序时,尤其是代码量比较大的程序,及时、准确地加上你自己的注释也是很重要的事。添加注释不限方式,可以在打印稿或者书上写注释;如果阅读的是电子版的代码,直接在编辑器中写上注释。通过写注释,将别人的编程思想及时用自己的话写下来,用“写下来”的这个动作,与代码产生交互,在大脑中留下较为深刻的印象。写注释时也体现先整体再细节的原则,优先对大段功能的注释,然后追求对细节的注释。阅读代码时难免会出现理解上的错误,及时地修改注释,记录下正确理解的历程。写注释还能避免读明白了却后边忘了前边的现象,也可以避免不必要的重复阅读,有助于保证学习效率。

  同一段代码可以有意识地对其反复阅读,这有助于对代码的理解。在第一次阅读代码的时候可以跳过非常多的一时不明白的代码段,只写一些简单的注释或提出问题。在以后的重复阅读过程中,对代码的理解会一次比一次更深刻,及时修改那些注释错误的地方,并且补足上一次没有理解的地方。对一段认为已经理解的代码再重读一次,往往还会发现以前没有注意到的细节。

  阅读程序时。不管程序是否能够运行,要学会“用人脑执行程序”,按照计算机执行程序的步骤去“执行”程序。大脑是CPU,拿张空白纸过来,当作内存,在程序运行过程中产生的各种数据的变化都写到“内存”上去,手、眼、脑并用。这样读程序,是掌握程序中的细节的方法,尤其是当程序中包含复杂的算法时,这更是一种必要且有效的方法。有些复杂的程序,涉及到函数参数传递、数组、指针,写出内存中数据变化的过程,会让程序在大脑中的执行可视化,“纸上谈兵”中,将程序玩弄于股掌之中。

  可以将要阅读的代码先运行起来,先对程序有感性认识,再设法对其进行理性分析。如果阅读的程序本来就是可以执行的,这样做很容易。而如果阅读的程序只是一些独立的函数,可以围绕这些函数编些测试程序,调用要阅读的函数。可以用单步跟踪的方法执行程序,可以理解函数的调用关系和执行流程,开启观察窗口可以获得更多的细节,设置断点提高跟踪的效率,让计算机充分参与、辅助理解程序。

你可能感兴趣的:(贺利坚-如何阅读代码(已阅加重点划))