学会读代码

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

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

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

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

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

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

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

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

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

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

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

本文来源:《逆袭大学——传给IT学子正能量》一审过后,要压缩篇幅,将整理过的文字登在些处共享。

==================== 迂者 贺利坚 CSDN博客专栏=================

|==  IT学子成长指导专栏  专栏文章分类目录(不定期更新)    ==|

|== C++ 课堂在线专栏   贺利坚课程教学链接(分课程年级)   ==|

======== 为IT菜鸟起飞铺跑道,和学生一起享受快乐和激情的大学 =======

时间: 2024-10-02 22:41:41

学会读代码的相关文章

《高效能程序员的修炼》一学会读源代码

学会读源代码 高效能程序员的修炼在"沟通"这个复杂的领域里,写出能让人类领会并理解的连贯段落比敲出几行不至于让解释器或编译器"呕吐"的软件代码要难得多. 这就是为什么--就软件开发而言--所有的文档大概都是很差劲的.而且,由于为人写作比为机器写作要困难得多,恐怕在可预见的将来,文档还会继续差劲下去.对此,你基本上是无能为力的. 除了做一件事-- "卢克1,学着去读源代码." JavaScript"始终带有源代码"是一股革命性的

编写可读代码的艺术

这是<The Art of Readable Code>的读书笔记,再加一点自己的认识.强烈推荐此书: 英文版:<The Art of Readable Code> 中文版:编写可读代码的艺术 代码为什么要易于理解 "Code should be written to minimize the time it would take for someone else to understand it." 日常工作的事实是: 写代码前的思考和看代码的时间远大于真正写

c++-读代码遇到这个,以前没有碰得到过

问题描述 读代码遇到这个,以前没有碰得到过 // main encoder loop while (pic_in && !b_ctrl_c) { ... } fail: x265_encoder_get_stats(encoder, &stats, sizeof(stats)); ... 解决方案 是不是while语句中有goto语句啊?当循环中判断失败时,直接goto 到fail标签,执行下面的函数 解决方案二: windows引导文件吧

读代码整洁之道

      现在的软件系统开发难度主要在于其复杂度和规模,客户需求也不再像Winston Royce瀑布模型期望那样在系统编码前完成所有的设计满足用户软件需求.在这个信息爆炸技术日新月异的时代,需求总是在不停的变化,随之在2001年业界17位大牛聚集在美国犹他州的滑雪胜地雪鸟(Snowbird)雪场,提出了"Agile"(敏捷)软件开发价值观,并在他们的努力推动下,开始在业界流行起来.在<代码整洁之道>(Clean Code),提出一种软件质量,可持续开发不仅在于项目架构设

怎样学会JS代码?

1:首先看书了解大概概念!    书要略读,目的是,基本了解js!     这个时间不要太长,看进度,几天到一个礼拜! 2:在上网时,根据不同的页面效果,拔他的源码看!     并做笔记!自己仿造做效果!在网上常用的一定是js最重要需要掌握的知识! 3:在看源代码的时候,要结合书和百度来掌握所学!      复习! 4:瞄准ajax,这时候js不再是一个做效果的小玩意了! 以上也是我从网上搜集来地  感觉不错  你可以参考下哦  我也是初学者  一起努力@!

关于“IT学子成长指导”专栏及文章目录

迂者专栏关键词 就 业 大一 大二 大三 大四 自学 职 场 专业+兴趣 研究生 硕士 规 划 考 研 大学生活 迷 茫 计算机+专业 基本功 学习方法 编程 基 础 实践 读书 前 途 成 长 社团 课程 IT行业 奋 斗 CSDN社区对我的专访.再访(一).再访(二).我的大学.Follow my heart,将为IT菜鸟起飞建跑道的事业进行下去. 本博义务咨询纯利用业余时间,本职工作需要优先,故不能保证所有来信在当天能得到回复,有的问题还需要给我留出思考时间.来信只需一封,请不要用一信多发

《逆袭大学——传给IT学子正能量》一审稿目录

<逆袭大学--传给IT学子正能量>一审过后,决定:(1)删掉一些文字,缩减篇幅,降低成本,使读者能够以尽可能低的价钱看到书:(2)调整目录结构,确实下面的三级目录结构太庞大了,也显得乱了. 正在准备的二审稿的目录已经调整为12章,只到二级目录,希望能够给读者一种更清新些的感觉. 先公布一审稿目录,作为对很长一段时间以来工作的纪念. 1 沦陷在大学里 1 1.1 迷茫的大学 11.2 说说大学这滩泥淖 31.2.1 泥淖和ní nào 41.2.2 大学,美丽而凶险的泥淖 41.2.3 大学之大

走在《逆袭大学》的征程上

历时大半年的写作,半多时间的后期出版流程,拙作<逆袭大学--传给IT学子的正能量>终于出版,并在China-Pub上首发销售了.承蒙厚爱,CSDN上的博友.身边的同事.认识的同行,尤其是和我相处过的学生,试读过和没有试读过的人们,给了这本书很大的期待和赞许.真正的挑战现在就开始,会有很多对作者我一无所知的人阅读这本书,能否如题名所言,实现对大学的逆袭,自认的正能量是否能够成为大学生成长的动力,市场说了算. 长达一年多的出版过程告一段落,围绕题目,说点事.    china-pub | 亚马逊 

《逆袭大学——传给IT学子的正能量》进展及最终目录

<逆袭大学--传给IT学子的正能量>一书8月底完成作者和编辑的几次修改之后,按计划本应该在10月底出版,但不得不遗憾地通知所有关心这本书的老师.同学:这本书正式出版已经延期到了年底. 事情是这样的.出版社审查组认为原文在定位上太泛,且没有从一开始就抓住IT专业的话题,担心讲大学.学习多了学生会看不下去.我坚持IT大学生出的问题,专业不是主要的,问题出在大学的看法和学习方法上,以及绕不开的各种现实问题,只有从大学.学习入手,再谈到学习.问题,才能起到帮IT学子解惑的目标.审查组坚持要来一次大改,