如何阅读代码?理论+实践 非常棒

http://www.cocoachina.com/gamedev/misc/2013/0729/6688.html

1.尽力构建并运行代码。 这通常是一个简单的步骤,就像你在看可运行的代码(这和随机代码相反)。 不过,并非总是如此。通过构建和执行代码,你能从中学到很多上层代码结构。 说到工作代码,你是否非常熟悉如何构建你的当前项目? 虽然构建通常非常复杂,但通过构建并生成可执行的代码,你能学到很多。

 

2. 不要只注重细节。 你要做的第一件事是,在你正阅读的代码中,找到代码结构和风格的。 首先浏览一下代码,尽力理解不同代码段要做什么。这会让你熟整个代码的上层结构,你也能领会到你正处理的代码的一些构思(良好架构和意大利面条等)。 这时候,你可以找到切入点(不管它是什么,主函数、servlet或控制器等),并查看代码如何在那里分支。 不要在这上面花过多的时间,随着你愈加熟悉代码,你可以随时回来查看。

 

3. 确信自己理解所有结构。 除非你碰巧是所用编程语言的首席专家,否则该语言有些它能做的事你可能还不知道。当你在浏览代码时,记下所有你或许不熟悉的结构。 如果有很多不熟悉的结构,你要做的下一步非常明显。
如果你不知道代码要做什么,那你就走不了很远。 即便只有几个你不熟悉的结构,你应当深入查看。 你现在是在探索你所用编程语言中你以前不知道的东西,为此花几个小时来阅读代码,我也非常乐意。

 

4. 既然你对大多数结构已有很好了解,那现在是该做些随机深入研究了。 就像步骤2,开始浏览代码,当这次要挑选一些随机函数或类,并开始逐行详细查看。 这是硬仗开始的地方,但也是你要取得主要成功的地方。 这里的构想,会形成你正在查看的代码库的思维模式。 也不要在这上面花过长的时间,但在继续前行之前,你要尽力并极大吸收一些有内容的代码块。 这个步骤,你也可以随时反复回过头来,每次你都会了解更多的背景,并收获更多。

 

5. 毫无疑问,在前面这些步骤中,肯定有你困惑的地方,所以这是你做些测试的最佳时间。 在测试的时候,你的麻烦可能会更少,同时你也能理解代码。 我一直感到奇怪,开发人员忽略一套写得很好很全面的测试代码,而尽力去阅读并理解某些代码。 当然了,有时候并没有测试。

 

6. 如果你说没有测试,那这听起来是编写测试的时候了。 (编写测试)有很多益处,有助于你自己的理解,有助于你提升代码库,阅读代码时也能编写代码,这是该你出手做些事的时候。 即便已经有了测试,通常你也可以编写一些测试,你总能受益的。 测试代码通常需要换种方式思考问题,那些你以前不太明了的概念也会变得更清晰。

 

7. 提取奇特的代码,使其成为单独的程序。我发现阅读代码是个非常有趣的练习,即便只为节奏变化。 即便你不了解代码的底层细节,你或许能知道一些代码在上层结构上要做什么。 什么不提取一些特定的函数,单独列为独立的程序。 当你在执行小段程序时,调试也会更简单。反过来说,可能还需要一些额外的步骤,才能理解你正查看的代码。

 

8. 代码不干净?有异味? 为什么不重构它?
我并不建议你重写整个代码库,但重构部分代码,真的有助于你理解层次上升一层。 把你理解的函数拿出来,改成独立的函数。 在你知道之前,原来的大函数看起来易管理,你可以在脑海中修改它。 重构允许你把代码变成自己的,无需完成重写代码。 如果有好的测试,有助于重构,但即便你没有好的测试,抽取你确定的函数并做测试。 即便测试看起来完全不充分,但作为一个开发人员,你得学着相信你的技能,有时候你只需努力去做(重构)。(如果你必须重构,你通常都可以把代码恢复原状。)

 

9. 如果没什么能帮上忙,那你就找个阅读代码的同伴。或许并非只有你一个人能从这代码中获益,所以去找一个人,一起阅读代码吧。 但你别找专家,他们会从上层结构上,向你解释所有东西,你会错失那些你自己详细查看代码时所能学到的细微差别。 然而,如果不见效的话,你也不能理解,有时候,你能做的最好的事就是去问。 向你的同事请教,如果你正在阅读开源代码,可以在互联网上找人问问。 但是你要记住,这是最后一步,而不是第一步。

 

如果我时间紧迫,需要快速合理地理解某些代码,并且我只能挑选上述步骤的其中一个,那我会选择“重构”(即:第8个步骤)。 虽然你能理解的东西不会很多,但那些你领会的东西,你会牢牢记住的。 总之,有件事你需要记在心里。 如果你新接触一个重要的代码库,你不可能立即能理解它。 这需要数天、数周和数月的潜心努力,接受这个事实。 即便有一位专家和你在一起,也不能明显地缩短时间(。 然而,当涉及到代码库时,如果你能耐心并有条不紊地阅读(和编写)代码,你最终能熟悉项目的方方面面,你能成为大牛。 你或者是逃避阅读代码,经常寻求某人帮你讲解某事。
我知道我会成为哪一种人。

 

寻找阅读代码的机遇 – 不要错失

我们喜欢编写新代码,是因为我们这次能正确处理问题。 好吧,也许不是这次,但一定是下次。 事实上是,你经常改进你的技术,但你从没有恰当地处理问题。 这就是编写新代码的价值所在,你可以历练并磨练你的技能,但阅读和把玩其他人编写的代码,(如果没有更多的价值,)也是有同样多的价值。 你不仅能从中获得一些有价值的技术知识,也能收获领域知识,领域知识通常仍具更多价值(毕竟,代码是文档的最终形式)。

 

即便代码写得很神秘,无任何惯例可言,但还是有价值。 你知道我在说的代码,它几乎看起来晦涩难懂,但不是有意而为之(因某些原因,Perl语言代码通常是这样的)。 不管什么时候我看到那样的代码,我都会这样想: 把它想象成只有你破译它后才能学到的东西。 是的,这是主要的痛楚之处,但要接受它,有时候你自己也会因琐碎的原因而写出那种使人困惑的代码(否认没有用,你知道这是真的)。 好了,如果你花些时间来阅读那样的代码,你更有可能最终写出同样的代码。并不说你将会写出那样的代码,但你有能力写出那样的代码。 最后,态度通常是最重要的(编注:态度决定一切)。
如果你视阅读代码为日常繁琐的工作,那它就是(繁琐的工作),并且你会逃避,但如果你视其为一个机遇,那好事终将到来。

时间: 2024-10-22 03:34:02

如何阅读代码?理论+实践 非常棒的相关文章

摘自《代码阅读方法与实践》

第一章:导论要养成一个习惯,经常花时间阅读别人编写的高品质代码.要有选择地阅读代码,同时,还要有自己的目标.您是想学习新的模式.编码风格.还是满足某些需求的方法?要注意并重视代码中特殊的非功能性需求,这些需求也许会导致特定的实现风格.在现有的代码上工作时,请与作者或维护人员进行必须的协调,以避免重复劳动或因此而产生厌恶情绪.请将从开放源码软件中得到的益处看作是一项贷款,尽可能地寻找各种方式来回报开放源码社团.多数情况下,如果您想要了解"别人会如何完成这个功能呢?",除了阅读代码以外,没

较好的代码维护实践

在别人实现的基础上进行开发,基本是一种常态.特别是对原来的代码陌生的情况下,有没有什么好的实践方法呢? 基本原则:类似重构一样,尽量减少对原有流程和结构的修改,最好能兼容原有结构.上来就按自己的相法来修改代是比较容易的,这样做很大程度是因为理解原有的代码需要较长的时间且有一定的难度,但这样会增加系统的复杂度,也会引入许多不必要的风险.除非得到项目负责人的同意,否则相当然的直接动手重写,绝非是什么好事! 那么如何做呢?要花大量的时间从头阅读代码吗?你以为文档写得那么好吗? 嗯,阅读代码和文档是免不

JavaScript语法树与代码转化实践

JavaScript 语法树与代码转化实践 归纳于笔者的现代 JavaScript 开发:语法基础与实践技巧系列文章中.本文引用的参考资料声明于 JavaScript 学习与实践资料索引中,特别需要声明是部分代码片引用自 Babel Handbook 开源手册;也欢迎关注前端每周清单系列获得一手资讯. JavaScript 语法树与代码转化 浏览器的兼容性问题一直是前端项目开发中的难点之一,往往客户端浏览器的升级无法与语法特性的迭代保持一致;因此我们需要使用大量的垫片(Polyfill),以保证

装X式的阅读代码,无需开启Android Studio来运行项目

这篇博文主要是给自己做个笔记,木有啥技术可言,也是方便自己在阅读代码的时候省去繁重的AS带来卡卡的感觉. 这篇博文是stormzhang大神那参考来的,很久就久仰大名了,今天没事逛了下他的博客,写的很全面,还有一些代码之外的问题探讨,让自己开阔了不少眼界,继续follow学习 现在,我们手上什么都没有,接下来,我们来一步一步的实现 随便找一个github上面的源码下载下来 用git clone 把源码下载下来,你也可以把压缩包下下来都可以,我用的是这个源码 然后cd到下载下来的目录 或许你已经看

编程人员阅读代码的一些小技巧分享_相关技巧

代码阅读的必要性 阅读别人的代码作为研发人员是一件经常要做的事情.一个是学习新的编程语言的时候通过阅读别人的代码是个最佳的学习方法,另外是积累编程经验.如果你有机 会阅读一些操作系统的代码会帮助你理解一些基本的原理.更有就是在你作为一个质量确保人员或一个小领导的时候如果你要做白盒测试的时候没有阅读代码的能力 是不能完成相应的任务.最后一个就是如果你中途接手一个项目的时候或给一个项目做售后服务的时候是要有阅读代码的能力的. 收集所有可能收集的材料 阅读代码要做的第一件事情是收集所有和项目相关的资料

敏捷开发中高质量Java代码开发实践

概述 Java 项目开发过程中,由于开发人员的经验.代码风格各不相同,以及缺乏 统一的标准和管理流程,往往导致整个项目的代码质量较差,难于维护,需要较 大的测试投入和周期等问题.这些问题在一个项目组初建.需求和设计均具有不 完全可预期性和完备性的全新项目中将尤为突出.本文将结合敏捷开发周期短, 变化快等特点,介绍如何通过在开发过程中采取一系列步骤来保证和提高整个开 发团队的代码质量,并阐述了每一步可以利用的工具和最佳实践,从而使开发过 程更加规范化,成就高质量的代码,减少测试的投入,并促进整个团

编写「可读」代码的实践

编写可读的代码,对于以代码谋生的程序员而言,是一件极为重要的事.从某种角度来说,代码最重要的功能是能够被阅读,其次才是能够被正确执行.一段无法正确执行的代码,也许会使项目延期几天,但它造成的危害只是暂时和轻微的,毕竟这种代码无法通过测试并影响最终的产品:但是,一段能够正确执行,但缺乏条理.难以阅读的代码,它造成的危害却是深远和广泛的:这种代码会提高产品后续迭代和维护的成本,影响产品的稳定,破坏团队的团结(雾),除非我们花费数倍于编写这段代码的时间和精力,来消除它对项目造成的负面影响. 在最近的工

微软资深软件工程师:阅读代码真的很难

导读:原文作者Eric Lippert是一名资深软件设计工程师,从1996年起一直在微软开发部门任职,协助设计并实现VBScript.JScript.JScript .NET.Windows Script Host.Visual Studio Tools for Office和C#. 以下是文章内容: Escalation的工程师JeremyK在他博客中问到: 你是怎么教人们快速深入挖掘不熟悉的代码(不是自己所写的)?我学习如何编程的方法很传统--自己动手编码.但我现在很纠结:到底是集中精神阅读

理论实践:循序渐进理解AWR细致入微分析性能报告

黄凯耀 (Kaya) ACOUG核心会员,高级技术专家 曾经工作于Oracle Real World Database Performance Group,一个隶属于Oracle公司总部数据库产品管理的核心团队.大学及研究生时期专注于Linux应用开发和Linux内核开发工作. 编辑手记:AWR是Oracle数据库中一个非常重要的诊断工具,通过度量而展现问题,每一个DBA都应当深入理解这其中的知识,本文通过讲解和分析,展示AWR分析的过程. 概述:本篇文章重点对 AWR 报告中的 DB Time