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

简介: http://www.cocoachina.com/gamedev/misc/2013/0729/6688.html 1.尽力构建并运行代码。 这通常是一个简单的步骤,就像你在看可运行的代码(这和随机代码相反)。

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


1.尽力构建并运行代码。 这通常是一个简单的步骤,就像你在看可运行的代码(这和随机代码相反)。 不过,并非总是如此。通过构建和执行代码,你能从中学到很多上层代码结构。 说到工作代码,你是否非常熟悉如何构建你的当前项目? 虽然构建通常非常复杂,但通过构建并生成可执行的代码,你能学到很多。
 
2. 不要只注重细节。 你要做的第一件事是,在你正阅读的代码中,找到代码结构和风格的。 首先浏览一下代码,尽力理解不同代码段要做什么。这会让你熟整个代码的上层结构,你也能领会到你正处理的代码的一些构思(良好架构和意大利面条等)。 这时候,你可以找到切入点(不管它是什么,主函数、servlet或控制器等),并查看代码如何在那里分支。 不要在这上面花过多的时间,随着你愈加熟悉代码,你可以随时回来查看。
 
3. 确信自己理解所有结构。 除非你碰巧是所用 编程语言的首席专家,否则该语言有些它能做的事你可能还不知道。当你在浏览代码时,记下所有你或许不熟悉的结构。 如果有很多不熟悉的结构,你要做的下一步非常明显。 如果你不知道代码要做什么,那你就走不了很远。 即便只有几个你不熟悉的结构,你应当深入查看。 你现在是在探索你所用编程语言中你以前不知道的东西,为此花几个小时来阅读代码,我也非常乐意。
 
4. 既然你对大多数结构已有很好了解,那现在是该做些随机深入研究了。 就像步骤2,开始浏览代码,当这次要挑选一些随机函数或类,并开始逐行详细查看。 这是硬仗开始的地方,但也是你要取得主要成功的地方。 这里的构想,会形成你正在查看的代码库的思维模式。 也不要在这上面花过长的时间,但在继续前行之前,你要尽力并极大吸收一些有内容的代码块。 这个步骤,你也可以随时反复回过头来,每次你都会了解更多的背景,并收获更多。
 
5. 毫无疑问,在前面这些步骤中,肯定有你困惑的地方,所以这是你做些测试的最佳时间。 在测试的时候,你的麻烦可能会更少,同时你也能理解代码。 我一直感到奇怪,开发人员忽略一套写得很好很全面的测试代码,而尽力去阅读并理解某些代码。 当然了,有时候并没有测试。
 
6. 如果你说没有测试,那这听起来是编写测试的时候了。 (编写测试)有很多益处,有助于你自己的理解,有助于你提升代码库,阅读代码时也能编写代码,这是该你出手做些事的时候。 即便已经有了测试,通常你也可以编写一些测试,你总能受益的。 测试代码通常需要换种方式思考问题,那些你以前不太明了的概念也会变得更清晰。
 
7. 提取奇特的代码,使其成为单独的程序。我发现阅读代码是个非常有趣的练习,即便只为节奏变化。 即便你不了解代码的底层细节,你或许能知道一些代码在上层结构上要做什么。 什么不提取一些特定的函数,单独列为独立的程序。 当你在执行小段程序时,调试也会更简单。反过来说,可能还需要一些额外的步骤,才能理解你正查看的代码。
 
8. 代码不干净?有异味? 为什么不 重构它? 我并不建议你重写整个代码库,但重构部分代码,真的有助于你理解层次上升一层。 把你理解的函数拿出来,改成独立的函数。 在你知道之前,原来的大函数看起来易管理,你可以在脑海中修改它。 重构允许你把代码变成自己的,无需完成重写代码。 如果有好的测试,有助于重构,但即便你没有好的测试,抽取你确定的函数并做测试。 即便测试看起来完全不充分,但作为一个开发人员,你得学着相信你的技能,有时候你只需努力去做(重构)。(如果你必须重构,你通常都可以把代码恢复原状。)
 
9. 如果没什么能帮上忙,那你就找个阅读代码的同伴。或许并非只有你一个人能从这代码中获益,所以去找一个人,一起阅读代码吧。 但你别找专家,他们会从上层结构上,向你解释所有东西,你会错失那些你自己详细查看代码时所能学到的细微差别。 然而,如果不见效的话,你也不能理解,有时候,你能做的最好的事就是去问。 向你的同事请教,如果你正在阅读开源代码,可以在互联网上找人问问。 但是你要记住,这是最后一步,而不是第一步。
 
如果我时间紧迫,需要快速合理地理解某些代码,并且我只能挑选上述步骤的其中一个,那我会选择“重构”(即:第8个步骤)。 虽然你能理解的东西不会很多,但那些你领会的东西,你会牢牢记住的。 总之,有件事你需要记在心里。 如果你新接触一个重要的代码库,你不可能立即能理解它。 这需要数天、数周和数月的潜心努力,接受这个事实。 即便有一位专家和你在一起,也不能明显地缩短时间(。 然而,当涉及到代码库时,如果你能耐心并有条不紊地阅读(和编写)代码,你最终能熟悉项目的方方面面,你能成为大牛。 你或者是逃避阅读代码,经常寻求某人帮你讲解某事。 我知道我会成为哪一种人。
 
寻找阅读代码的机遇 – 不要错失
我们喜欢编写新代码,是因为我们这次能正确处理问题。 好吧,也许不是这次,但一定是下次。 事实上是,你经常改进你的技术,但你从没有恰当地处理问题。 这就是编写新代码的价值所在,你可以历练并磨练你的技能,但阅读和把玩其他人编写的代码,(如果没有更多的价值,)也是有同样多的价值。 你不仅能从中获得一些有价值的技术知识,也能收获领域知识,领域知识通常仍具更多价值(毕竟,代码是文档的最终形式)。
 
即便代码写得很神秘,无任何惯例可言,但还是有价值。 你知道我在说的代码,它几乎看起来晦涩难懂,但不是有意而为之(因某些原因,Perl语言代码通常是这样的)。 不管什么时候我看到那样的代码,我都会这样想: 把它想象成只有你破译它后才能学到的东西。 是的,这是主要的痛楚之处,但要接受它,有时候你自己也会因琐碎的原因而写出那种使人困惑的代码(否认没有用,你知道这是真的)。 好了,如果你花些时间来阅读那样的代码,你更有可能最终写出同样的代码。并不说你将会写出那样的代码,但你有能力写出那样的代码。 最后,态度通常是最重要的(编注:态度决定一切)。 如果你视阅读代码为日常繁琐的工作,那它就是(繁琐的工作),并且你会逃避,但如果你视其为一个机遇,那好事终将到来。

目录
相关文章
|
1月前
|
机器学习/深度学习 人工智能 自然语言处理
技术小白能看懂的ChatGPT原理介绍
网上有关 ChatGPT 的原理介绍文章一大堆,要么是从 NLP 的历史开始讲起,要么是上数 GPT 3 代,内容都相对冗长和复杂。其实 ChatGPT 的原理并不难理解,我将以最通俗易懂的方式为技术小白解读,帮助大家更好地了解这一技术
501 1
技术小白能看懂的ChatGPT原理介绍
|
4月前
|
算法 芯片
嵌入式工程师如何快速的阅读datasheet的方法
嵌入式工程师如何快速的阅读datasheet的方法
56 0
|
6月前
|
机器学习/深度学习 人工智能 算法
这篇科普让你Get所有大模型的基础核心知识点
本文介绍了AI大模型的概念和发展历程。AI大模型是指具有1亿以上参数的机器学习模型,通过在大规模数据集上进行预训练,可以直接支撑各类应用。大模型的发展经历了从萌芽期到AI1.0时期,再到AI2.0时期的飞跃,目前最新发布的大模型参数已经达到了千亿甚至万亿级别。国内外的公司都在积极研发和应用大模型,如OpenAI、Google、Facebook、Microsoft等。国内也有百度、阿里巴巴、万维、商汤科技等公司发布了自己的大模型产品。大模型的建造离不开算力资源、算法人才、数据积累等核心要素。此外,文章还列举了一些与大模型相关的专业名词,如算法、模型参数、训练数据、Token等。
|
7月前
|
消息中间件 设计模式 缓存
怎样更好地阅读源码?
最近,为了提高团队成员技术水平,考察了大家源码阅读情况。作为第一期任务,选择了spring框架,范围是spring-beans,spring-context,spring-core,以及spring-web。考核方式为:了解spring框架作用、核心概念,并选择感觉最重要的几个类进行详细阐述。
68 0
|
9月前
|
设计模式 算法 搜索推荐
软件设计师总结-含括学习方法和学习过程,可参考(下)
软件设计师总结-含括学习方法和学习过程,可参考(下)
|
9月前
|
设计模式 算法 开发工具
软件设计师总结-含括学习方法和学习过程,可参考(上)
软件设计师总结-含括学习方法和学习过程,可参考(上)
|
9月前
|
SQL 安全 搜索推荐
学编程遇到问题,如何更好地提问?
不要只把你不懂的地方拿出来问而不提及问题的前因后果,否则回答者可能无法明白你的问题。尽量客观描述问题,而不是只说自己的理解和假设。在客观描述的基础上,你可以再加上自己的判断和尝试解决的结果。
|
设计模式 Java 程序员
理论与实践:如何写好一个方法
鉴于团队越来越强调开发规范,本人被diss了很多次,haha,为了改变这一现状,总结了一些提升方法代码质量的方法。个人认为一个好的方法主要表现在可读性、可维护性、可复用性上,本文通过设计原则和代码规范两章来讲解如何提高方法的可读性、可维护性、可复用性。这些设计原则和代码规范更多的是表现一种思想,不仅仅可以用在方法上,也可以用在类上、模块上。下面通过具体的例子来讲解。设计原则单一原则单一职责解释是一
56 0
|
设计模式 算法 Java
《刻意练习》:以学习编程为例
《刻意练习》是一本神奇的魔法书,它用大量的事实案例和数据来证明了刻意练习能给一个人带来的巨大改变。更为难能可贵的是,它不仅仅只是介绍刻意练习的好处,还给读者介绍了刻意练习的方法和注意事项,可以说是干货满满的一本书。
355 0
|
算法
重温算法,加深理解
算法在开发中的地位我们都很清楚,但是呢实际上项目里用到的算法并不是很多,虽然不是必须但是我们还是要懂算法,理解算法,运用算法。前几年肝了很多算法,但是这玩意不经常练习就会忘记,今天就重新把算法捡起来吧。
72 0
重温算法,加深理解

热门文章

最新文章