如何阅读别人代码

合集下载

vscode阅读源码结构

vscode阅读源码结构

vscode阅读源码结构
在使用VSCode阅读源代码时,了解其结构是非常重要的。

下面是 VSCode 源代码的一些主要结构:
1. src 文件夹:这是 VSCode 源代码的主要文件夹,包含所有的 TypeScript 源文件。

2. package.json 文件:这是 VSCode 的包配置文件,包含了该项目的所有依赖项、脚本和其他信息。

3. out 文件夹:这是 VSCode 的编译输出文件夹,其中包含了最终生成的 JavaScript 代码。

4. test 文件夹:这是 VSCode 的测试文件夹,包含了所有的测试用例。

5. extensions 文件夹:这是 VSCode 的扩展文件夹,用于存放所有的 VSCode 扩展。

6. resources 文件夹:这是 VSCode 的资源文件夹,包含了所有的 VSCode 图标、主题和其他资源。

通过了解这些文件和文件夹的结构,您可以更好地理解 VSCode 的源代码,并更轻松地进行阅读和调试。

- 1 -。

怎么读没有注释的代码

怎么读没有注释的代码

阅读没有注释的代码可能会具有挑战性,但以下是一些建议,可帮助你更好地理解代码:
逐行阅读:从头到尾逐行阅读代码,尽量理解每一行的作用。

先了解代码的整体结构和流程。

理解关键字和语法:如果你熟悉编程语言,确保理解代码中使用的关键字和语法。

这对于理解代码的逻辑结构至关重要。

查找函数和变量定义:如果代码中使用了函数或变量,尝试找到它们的定义。

了解它们的用途和如何被使用可以帮助你理解整个代码。

注重代码块:将代码分为较小的块,集中关注每个代码块的功能。

这有助于缩小阅读的范围,提高理解的效率。

运行代码:如果可能,尝试运行代码并观察输出。

这可以帮助你更好地理解代码的实际行为。

查阅文档:如果代码使用了特定的库或框架,查阅相关的文档可能会提供更多关于代码目的和用法的信息。

寻求帮助:如果你在阅读代码时遇到困难,不要犹豫向有经验的同事、朋友或在线社区寻求帮助。

别人的见解可能会为你提供新的思路。

思考设计模式:尝试识别代码中可能使用的设计模式。

这有助于理解代码的整体结构和目的。

画流程图或注释:如果可能,尝试为代码画流程图或添加注释。

这有助于可视化代码的逻辑。

反复阅读:重复阅读代码,逐渐提高对整体结构和细节的理解。

随着时间的推移,你可能会更加熟悉和理解代码。

记住,阅读没有注释的代码需要耐心和细致入微的分析。

尽管有时会比较困难,但通过不断的努力和实践,你可以逐渐提高对未注释代码的理解水平。

如何读代码

如何读代码

如何读代码?为什么要会读代码?考虑这样一些场景:•Case 1: 你还在读书,照着教程,照着例子,学习编程。

刚开始,大概率是先读别人的代码,理解别人的代码,而非一上来,就开始写。

这是我YY的一个学写代码的学习模型,所以读了,理解了,在自己就可以发挥了,然后书本上、他人的知识,就流进了自己的脑瓜了。

•Case 2: 一个职场新人,一进公司,就加入一个项目组,那项目代码真是海了去了!然后老大可能给你一个小小的活,在现有基础上,添加一个小功能。

项目经验少的童鞋,一下就傻眼了,特么的,这代码这么多行,文件几百上千!该从何入手呢?别说改了,看都看不懂!完了,试用期是不是就要被干掉?!•Case 3: 你进了一个小公司,技术管理混乱,前任已闪人,你受命接任一个一坨翔一样的项目,那代码写的真是云里雾里,工期又紧,老板又逼着出货,怎么办?闪人?可是下家会更好么?跳槽往往是从一个坑里,跳到另一个坑里。

所以读吧,总是要读的。

•Case n: ......学校往往教授的是如何写代码,可能从没有教如何读代码。

然而,理想很丰满,现实很骨感!工作中,你写代码的时间可能只占工作时间很少很少的一部分,大部分时间你可能都是在阅读已有的代码,当然除非这个项目从0到1都是你一个人干,可即便是自己写代码,也是渐进增长、不断迭代的,也需要不断反复阅读自己写的代码。

再者,编程与写文章,有异曲同工之处。

编程与写作相似之处,都是用语言表达写作者的想法。

对于如何提升写作,古人曾讲:熟读唐诗三百首,不会作诗也会吟。

回想学生时代,老师也常说:读书破万卷,下笔如有神!强调写作需要大量阅读,读的多了,写作能力也会相应提升。

阅读之于写作,相辅相成,互为促进。

那么大量阅读别人的代码,也能提升自己的编程水平。

阅读代码,个人觉得会有这样些好处:博采众长优秀的源码,就如传世佳作一样,值得反复揣摩,细细品味。

其编写技巧、设计范式、架构思想,都具有极大的学习借鉴价值。

如何阅读别人的程序

如何阅读别人的程序

如何阅读别人的程序我们在写程序时,有不少时间都是在看别人的代码。

例如看小组的代码,看小组整合的守则,若一开始没规划怎么看,就会云深不知处了!不管是参考也好,从开源抓下来研究也好,为了了解其中含意,在有限的时间下,不免会对庞大的源代码解读感到压力。

网络上有一篇关于分析看代码的方法,做为程序设计师的您,不妨参考看看,换个角度来分析。

也能更有效率的解读你想要的程序代码片段。

摘要:(一)阅读他人的程序代码(1 )---读懂程序代码,使心法皆为我所用1.先了解系统架构与行为模式,再细读2.熟悉沟通语言与惯例用语3.掌握程序代码撰写者的心态与习惯(二)阅读他人的程序代码(2 )-摸清架构,便可轻松掌握全貌1.阅读程序代码的目的,在于了解全貌而非细节2.由上而下厘清架构后,便可轻易理解组成关系3.了解架构,必须要加上层次感4.探索架构的第一件事:找出系统如何初始化5.探索架构的第一步─ ─找到程序的入口 ()(三)阅读他人的程序代码(5 )-找到程序入口,再由上而下抽丝剥茧1.展开的同时,随手记录树状结构2.无法望文生义的函数,先试着预看一层3.根据需要了解的粒度,决定展开的层数阅读他人的程序代码( 1 )---读懂程序代码,使心法皆为我所用程序代码是别人写的,只有原作者才真的了解程序代码的用途及涵义。

许多程序员心里都有一种不自觉的恐惧感,深怕被迫去碰触其他人所写的程序代码。

但是,与其抗拒接收别人的程序代码,不如彻底了解相关的语言和惯例,当成是培养自我实力的基石。

对大多数的程序员来说,撰写程序代码或许是令人开心的一件事情,但我相信,有更多人视阅读他人所写成的程序代码为畏途。

许多人宁可自己重新写过一遍程序代码,也不愿意接收别人的程序代码,进而修正错误,维护它们,甚至加强功能。

这其中的关键究竟在何处呢?若是一语道破,其实也很简单,程序代码是别人写的,只有原作者才真的了解程序代码的用途及涵义。

许多程序员心里都有一种不自觉的恐惧感,深怕被迫去碰触其他人所写的程序代码。

idea阅读源码技巧

idea阅读源码技巧

idea阅读源码技巧
1、了解项目背景及设计架构
在学习阅读源代码之前,首先应该尽可能详细地了解整个项目的背景及设计架构。

例如,对于某个项目,其结构可能如下:数据层(存储模块)、业务层(服务模块)、表示层(运行界面)、用户接口层(API调用)等。

通过了解该项目的整体设计架构,可以帮助我们更快地定位和解决代码问题,也有助于更好地理解源码。

2、查看类与函数的详细信息
接下来,我们使用IDE(例如IntelliJ IDEA)在项目的理解和调试方面帮助,并仔细检查每个类和函数的详细信息:什么参数输入,什么参数输出?什么事件会被触发?当什么参数传入时,什么结果会产生?这些解决方案可以帮助我们轻松理解代码,记住小心细节!
3、熟悉代码框架
在了解了整个项目框架之后,需要了解项目中使用的代码框架。

例如,如果是面向对象编程语言,则可以了解类和接口的使用方法;如果是函数式编程语言,则可以深入掌握函数、流式编程等概念;如果是脚本语言,则可以深入了解语法规则、变量作用域等。

熟悉常用的代码框架可以帮助我们阅读源码时更快捕捉关键点。

4、利用注释和文档积累经验
在阅读代码时,要格外注意代码中出现的注释和文档,仅通过注释和文档就可以大致了解代码的功能和思路,并在遇到问题时积累经验,帮助自己解决问题。

5、精心设计模块
最后,在阅读完每个模块后,要尽可能精心设计模块,充分利用继承或接口的优势,使代码实现的功能更高效、更便捷地完成。

这样,既可以加快阅读源码的效率,又可以减少调试过程中的坑,在阅读源码时综合利用以上方法有助于加深各位理解源码的能力。

阅读代码技巧

阅读代码技巧

阅读代码是一项非常重要的技能,无论你是初学者还是资深的程序员,都需要掌握一些阅读代码的技巧。

下面是一些有关阅读代码的技巧:
1.阅读注释:注释通常会告诉你代码的作用、功能和实现方式,以及涉及到的参数和变量
的含义等信息。

当你不理解代码或者想深入了解某个函数或模块的时候,注释是一个很好的指导。

2.借助工具:使用IDE等开发工具,可以帮助你更加方便快捷地阅读代码,例如代码高亮、
括号匹配等功能,可以让你更好地理解代码结构和逻辑。

3.理解函数和类的作用:在阅读代码的过程中,你需要先明确函数和类的作用,以便更好
地理解它们的输入输出和调用方式。

4.查看文档:如果你阅读的是一个已经公开发布的代码库或函数库,可以查看相应的文档
来获得更多的信息。

文档通常会包含函数和模块的用法、参数解释以及示例代码等内容。

5.调试代码:如果你遇到一些不懂的代码,可以尝试利用调试工具对代码进行单步调试,
以便更好地观察代码执行情况和变量的值变化情况。

6.练习代码阅读:通过不断阅读代码,可以逐渐培养自己的代码阅读能力。

可以从简单的
代码开始练习,逐渐提高难度和深度,同时也可以参考别人对同一段代码的看法和分析,扩大视野。

如何阅读C++源代码

如何阅读C++源代码

如何阅读C++源代码如何阅读C++源代码(这是我在阅读C++源代码时总结的⼀些体会,以后还要把新的体会再补充进来,逐步扩充和完善本⽂。

)1. 读C++源代码时,按照声明⽂件(.h⽂件)和实现⽂件(.cpp⽂件)的顺序来读,先弄清楚各个类的组成,再弄清各个类的成员函数的实现,判定和理解各个成员函数的功能。

2. 在读C++源代码时,要注意类与类之间的静态联系和动态联系。

类与类之间的静态联系包括类之间的继承关系、组合关系等;类与类之间的动态联系包括类的成员函数之间的函数调⽤关系等。

3. 要会从C++程序的⼊⼝函数main函数开始读,main函数是整个程序的执⾏流程,通过跟踪这个执⾏流程,可以弄清这个程序是如何运⾏的,各个类在程序运⾏中如何互相发⽣联系。

1、采⽤最⾃然、最简单的设计。

只在必要时才采⽤精巧的设计。

2、平时编程和测试中遇到的错误,⼀定要清除,否则留到最后,成为难以琢磨的错误,到⽤户反馈回来再追踪,要花⼏倍甚⾄⼗⼏倍的时间。

3、涉及到从数据库读数据的问题,⼀定要考虑到连接是否释放,⼀定要测试是否会出现连接池满的情况,⽅法是,对模块进⾏数千次或更多次的连接和关闭,看是否会报连接池满的错误。

4、OOD(⾯向对象设计)要偏向于职责导向,⽽⾮问题导向。

5、快速编程的⽅法1: ⽤中⽂注释的⽅式写出中⽂流程。

在此过程中很⾃然地对模块进⾏了⾃顶向下的划分。

根据模块的功能确定函数的签名(即函数名和函数参数表)。

6、快速编程的⽅法2: ⾸先写出实现主要逻辑的⾻⼲代码(甚⾄可以只是完成逻辑流程的明确划分),再逐步精细化以及对⼀些过⼤的函数进⾏重构。

7、注意:不要过早陷⼊细节,⼀定要先完成主要逻辑代码,这是控制开发时间的关键。

8、不要想⼀步完成⼀个⼤任务,遇到这种情况最好是分成多步来完成。

⽐如,有时想把⼀个模块做得很完美,于是在每⼀步都写得很精细,这样的弊端是过早地陷⼊细节,开发时间就会拖得很长。

不如⾸先将代码的⾻⼲逻辑写出来,完成后,再精细化,这样开发进度就会容易控制得多。

如何阅读他人的程序代码

如何阅读他人的程序代码

常用的工具

IDE,例如Visual Studio 简化浏览 便利在不同的函式间切换跳跃 便于取得函式原型宣告 grep 允许我们搜寻某个目录(包括递归进到其所有子目 录)中所有指定档案,是否有符合指定条件(常数 字符串或正规表示式)档案 阅读、探索原始码时十分好用的工具

gtags (2/2)

提供了许多有用的额外检索方式 ,例如 找出项目中定义某个数据结构的档案及定义所在的 行号 找出项目中所有引用某数据结构的档案,以及引用 处的行号。
htags (1/4)

gtags所提供的工具,能够帮你将已制作完成的索引结 构,制作成为一组相互参考的HTML文件 直接阅读htags所产生的HTML文件,十分便利 比起单纯的直接阅读原始码,来得更有结构 已经为你建立起阅读程序代码时在各个原始码档案 片段间跳跃的链结
层层剥开感兴趣的部份


autoDetectIpod():产生侦测iPod插入的线程 ThreadFunc_AutoDetect:侦测iPod插入的线程 找出iPod所在的驱动器号 以驱动器号产生view_ipod物件 view_ipod建构式 - …略… - parseIpodDb() 当我们层层的予以探索、分解之后,找到了 parseIpodDb(),从函式名称就能判断出它是我们想要 的 parse iPod DB!
gtags (1/2)

GNU GLOBAL source code tag system
不单只会进行文字层次的搜寻 具备了各种语言的语法剖析器,使得它在进行搜寻时, 可以只针对和语言有关的元素,例如类别名称、函式 名称等等 它能针对原始码的内容进行索引 一旦建好索引之后,每次的搜寻动作,都毋需重新 读取所有原始码的内容并逐一搜寻 以现成的索引结构为基础,进行有效率的搜寻

如何阅读luajit的代码——用vs调试篇

如何阅读luajit的代码——用vs调试篇

如何阅读luajit的代码——⽤vs调试篇为什么要看luajit的源码作为⽬前最快的脚本语⾔之⼀,luajit确实是⼀个杰作,但相⽐原⽣lua仅仅⼏万⾏的代码⽽⾔,luajit却可以说是巨⽆霸。

更要命的是,luajit 之所以快,是因为⼤量使⽤了机器码相关的技术,⽆论是它的机器码编译部分,还是字节码执⾏部分,读起来都⾮常⿇烦。

⽹上这⽅⾯的资料⾮常少,即使是lua社区的云风⼤⼤也主要以分析原⽣lua为主,跟luajit有很多不同。

万⼀遇到了性能坑,或者其他难以解决的问题,需要找到原因,⼜不能阅读源码的话,就只能依赖⽹上其他⼈的结论,否则完全⽆从下⼿。

调试luajit万事的开头,从能够⾃⼰调试代码开始⼀个能调试的代码,阅读起来会远远⽐眼看要清晰得多。

⽽如果能利⽤visual studio进⾏调试,那么对读luajit⽽⾔还是⾮常有帮助的,毕竟借助visual assist的代码查找,能够⾮常快的帮你找到你想了解的东西luajit下⾯提供了⼀个msvcbuild.bat⽤于编译luajit,但如果你需要调试的话,可以进⾏以下⼏个步骤:1.将luajit解压,⽐如解压到LuaJIT-2.1.0-beta2_msvc⽬录2.如果要得到精确的栈,修改LuaJIT-2.1.0-beta2_msvc\src\msvcbuild.bat,搜索/O2,将/O2改为/Od3.在win64版本的visual studio命令⾏,执⾏⼀次msvcbuild.bat debug,这时会⽣成luajit.exe,测试⼀下exe是否正常。

4.⽤visual studio建⽴⼀个命令⾏⼯程,例如⼯程保存在LuaJIT-2.1.0-beta2_msvc\luajitcmd5.把LuaJIT-2.1.0-beta2_msvc\src下所有.h和.c代码加⼊⼯程6.把⼯程的调试路径设置为命令:$(ProjectDir)..\..\src\luajit.exe⼯作⽬录:$(ProjectDir)..\..\src\7.此时你可以正常按f5下断点调试了⾄于可以调试什么呢?最简单就是写⼀个lua⽂件,require之,执⾏⾥⾯的代码,下断点观察luajit的⾏为。

编程技巧:提高代码阅读能力的7个技巧

编程技巧:提高代码阅读能力的7个技巧

编程技巧:提高代码阅读能力的7个技巧1. 注释和文档良好的注释和文档是提高代码阅读能力的关键。

在编写代码时,务必添加清晰准确的注释,解释代码的功能、设计意图等。

同时,为函数、类和模块编写文档说明,包括输入输出参数、使用示例等,这有助于理解代码及其用途。

2. 命名规范选择有意义的变量名和函数名是提高代码阅读能力的重要一环。

使用清晰、简洁且有描述性的命名方式,可以使其他人更容易理解你的代码。

避免使用过于简短或不相关的名称,而是尽可能具体地反映变量或函数所代表的意义。

3. 模块化与函数分解将复杂任务分解为小块,并将其封装到独立的函数或模块中。

这种模块化方法可以使代码更易读、更易维护。

当你需要查看某个特定功能时,只需关注与之相关的特定模块或函数即可。

4. 使用合适的缩进和格式化正确的缩进和格式化对于阅读他人代码至关重要。

确保每个代码块都有一致且易于辨认的缩进,并选择合适的代码格式化约定,以减少理解代码所需的认知负担。

5. 测试与调试编写测试用例并进行单元测试是提高代码阅读能力的重要方法。

理解他人代码时,通过运行和调试测试用例可以更好地了解其功能和输入输出。

此外,在必要时使用调试工具有助于深入分析代码执行过程中的状态和变量值。

6. 学习面向对象编程(OOP)掌握面向对象编程可以使你更加容易理解他人的代码。

熟悉类、对象、继承等概念,并了解如何在自己的代码中使用这些概念,将帮助你更好地理解其他人所编写的面向对象风格的代码。

7. 阅读优秀源码阅读优秀开源项目或别人的优秀源码是提高代码阅读能力最有效的方法之一。

通过阅读他人写得好且可靠的源码,尤其是针对已经熟悉而感兴趣领域下某个具体问题的实现细节,你将受益匪浅,并且可以借鉴其中技巧来提升自己编程技能。

以上是提高代码阅读能力的7个技巧。

通过注释和文档、良好的命名规范、模块化与函数分解、适当的缩进和格式化、测试与调试、学习面向对象编程以及阅读优秀源码,你将能更流畅地理解他人代码,并自信地进行代码阅读和维护工作。

怎么看懂simulink生成的代码

怎么看懂simulink生成的代码

怎么看懂simulink生成的代码Simulink 是MATLAB 的一个模块,主要用于进行动态系统模拟和模型设计。

Simulink 支持将模型转换为C 代码,以便在嵌入式系统和其他硬件上实现。

要理解由Simulink 生成的代码,你需要对 C 语言和Simulink 的工作原理有一定的了解。

以下是阅读和理解Simulink 生成代码的一些基本步骤:1.了解Simulink 的工作原理:首先,你需要了解Simulink 是如何工作的。

Simulink基于图形化建模,你可以使用方块图来表示系统。

这些方块代表不同的功能,如数学运算、逻辑运算、信号处理等。

2.理解生成的代码结构:当你从Simulink 模型生成C 代码时,代码的结构会基于你的模型结构。

生成的代码通常包含一个主函数,以及为每个Simulink 模块生成的函数。

例如,如果你的模型包含一个“Gain”模块,那么在生成的代码中会有一个相应的函数来执行该模块的功能。

3.阅读和理解每个模块的代码:对于每个在模型中使用的模块,Simulink 会生成一个对应的C 函数。

这些函数实现了模块的功能。

你需要查看这些函数的源代码,以理解它们是如何工作的。

4.理解数据流:Simulink 中的模块通过数据流相互连接。

在生成的代码中,数据流表现为变量和参数传递。

你需要跟踪这些数据流,以理解代码是如何执行的。

5.使用调试器:MATLAB 提供了一个调试器,可以帮助你理解代码的执行过程。

你可以设置断点、单步执行代码、查看变量值等,这有助于你深入理解代码的工作原理。

6.查阅文档和示例:MATLAB 和Simulink 的官方文档提供了大量的信息和示例,可以帮助你理解如何使用这些工具。

7.实践和经验:随着时间的推移,通过阅读和理解更多的Simulink 生成的代码,你会积累更多的经验,并更好地理解这些代码的工作原理。

记住,理解由Simulink 生成的代码需要时间和实践。

如何阅读别人的代码

如何阅读别人的代码

如何阅读别人的代码阅读别人的代码作为开发人员是一件经常要做的事情。

一个是学习新的编程语言的时候通过阅读别人的代码是一个最好的学习方法,另外是积累编程经验。

如果你有机会阅读一些操作系统的代码会帮助你理解一些基本的原理。

还有就是在你作为一个质量保证人员或一个小领导的时候如果你要做白盒测试的时候没有阅读代码的能力是不能完成相应的任务。

最后一个就是如果你中途接手一个项目的时候或给一个项目做售后服务的时候是要有阅读代码的能力的。

收集所有可能收集的材料阅读代码要做的第一件事情是收集所有和项目相关的资料。

比如你要做一个项目的售后服务,那么你首先要搞明白项目做什么用的,那么调研文档、概要设计文档、详细设计文档、测试文档、使用手册都是你要最先搞到手的。

如果你是为了学习那么尽量收集和你的学习有关的资料,比如你想学习Linux的文件系统的代码,那最好要找到linux的使用手册、以及文件系统设计的方法、数据结构的说明。

(这些资料在书店里都可以找到)。

材料的种类分为几种类型1.基础资料。

比如你阅读turbo c2的源代码你要有turbo c2的函数手册,使用手册等专业书籍,msc 6.0或者Java的话不但要有函数手册,还要有类库函数手册。

这些资料都是你的基础资料。

另外你要有一些关于uml的资料可以作为查询手册也是一个不错的选择2.和程序相关的专业资料。

每一个程序都是和相关行业相关的。

比如我阅读过一个关于气象分析方面的代码,因为里边用到了一个复杂的数据转换公式,所以不得不把自己的大学时候课本找出来来复习一下高等数学的内容。

如果你想阅读linux的文件管理的代码,那么找一本讲解linux文件系统的书对你的帮助会很大。

3.相关项目的文档资料这一部分的资料分为两种,一个相关行业的资料,比如你要阅读一个税务系统的代码那么有一些财务/税务系统的专业资料和国家的相关的法律、法规的资料是必不可少的。

此外就是关于这个项目的需求分析报告、概要设计报告、详细设计报告,使用手册、测试报告等,尽量多收集对你以后的代码阅读是很重要的。

ideal如何做代码阅读笔记

ideal如何做代码阅读笔记

ideal如何做代码阅读笔记
在IDEA中做代码阅读笔记,可以按照以下步骤进行:
打开需要阅读的项目或代码文件。

在代码中,找到需要记录的代码段或功能模块,右键点击,选择“Go to Definition”或“Find Usages”等选项,跳转到相关代码的定义或使用位置。

在代码定义或使用位置,右键点击,选择“Add to Bookmarks”或“Add to Favorites”等选项,将该代码段或功能模块添加到书签或收藏夹中。

在IDEA的底部状态栏中,点击“Bookmarks”或“Favorites”等选项,打开书签或收藏夹管理页面。

在书签或收藏夹管理页面中,可以查看添加的书签或收藏夹,并可以对它们进行编辑、删除等操作。

如果你需要对书签或收藏夹中的代码进行注释或说明,可以右键点击书签或收藏夹中的代码,选择“Note”或“Annotate”等选项,添加注释或说明。

在注释或说明中,可以添加文字、图片、链接等内容,以便于后续的阅读和理解。

如果你需要将书签或收藏夹中的代码导出为笔记文件,可以右键点击书签或收藏夹中的代码,选择“Export to Notebook”等选项,将代码导出为笔记文件。

在导出笔记文件中,可以选择导出格式、导出内容等选项,以便于后续的阅读和使用。

通过以上步骤,你可以在IDEA中轻松地做代码阅读笔记,记录和整理自己的学习成果。

如何阅读和理解他人的代码

如何阅读和理解他人的代码

如何阅读和理解他人的代码代码是计算机程序的基础,也是开发者之间交流和合作的重要方式。

然而,阅读和理解他人的代码并不容易。

不同的开发者有不同的编码风格和思维方式,理解他们的代码需要一定的技巧和经验。

本文将介绍一些有效的方法,帮助读者更好地阅读和理解他人的代码。

1. 注重代码结构和命名规范在阅读代码之前,首先要注意代码的结构和命名规范。

一个良好的代码结构能够使代码更易于理解和阅读。

因此,在阅读代码之前,可以先浏览代码的目录结构,查看代码组织是否清晰。

此外,代码中的命名规范也是关键。

开发者应该使用有意义的变量名、函数名和类名,以提高代码的可读性。

读者可以根据命名规范来推测代码的功能和作用,从而更好地理解代码。

2. 弄清上下文和功能在阅读代码时,要先弄清楚代码的上下文和功能。

可以阅读代码所在的文件和目录,查找相关的注释或文档,了解代码所在的项目和模块。

此外,还可以查看代码的版本控制记录,了解代码的修改历史和背景信息。

通过这些方式,读者可以更好地理解代码所处的环境和功能。

3. 逐步调试和运行代码阅读他人的代码时,可以尝试逐步调试和运行代码。

通过运行代码,可以观察代码的输出和行为,验证代码的正确性。

此外,借助调试器等工具,可以逐步跟踪代码的执行过程,了解代码的逻辑和控制流程。

通过调试和运行代码,读者可以更直观地理解代码的具体实现方式和运行机制。

4. 注重代码的注释和文档在阅读代码时,注释和文档是宝贵的资源。

好的注释可以解释代码的关键逻辑、算法和设计思路,帮助读者理解代码的含义和目的。

因此,在阅读代码时,要注意查找和阅读注释。

此外,如果有文档或说明文件,也应该仔细阅读。

文档可以提供代码的使用方法和注意事项,指导读者更好地理解和利用代码。

5. 利用工具和资源为了更好地阅读和理解他人的代码,可以利用各种工具和资源。

例如,代码编辑器可以提供代码高亮、自动补全等功能,提高代码的可读性。

代码分析工具可以帮助检测代码中的潜在错误和问题。

如何阅读项目代码

如何阅读项目代码

如何阅读项目代码
想要阅读、理解并修改项目代码是每个程序员必须掌握的技能之一。

下面是一些建议,希望能帮助你更好地阅读项目代码:
1. 熟悉项目结构
在开始阅读代码之前,了解项目的整体结构是非常重要的。

你需要了解项目中每个文件的作用,以及它们如何相互关联。

通常,一个项目会有一个主要的入口文件,你可以从这里开始了解整个项目的结构。

2. 理解项目的设计原则
每个项目都有其设计原则,例如MVC、MVVM等。

了解这些原则可以让你更好地理解代码,知道每个类和方法的作用以及如何相互调用。

3. 了解项目中使用的技术
一个项目中通常会用到许多不同的技术,例如数据库、框架、第三方库等。

了解这些技术对理解代码非常重要。

4. 阅读文档和注释
项目的文档和注释是你了解代码的重要来源。

阅读文档可以让你更好地了解项目的结构和设计原则,而注释则可以让你了解每个变量和函数的作用。

5. 调试代码
调试代码是一个非常好的学习方式。

通过调试代码,你可以了解每个方法和变量的具体作用,以及它们之间的关系。

6. 和其他人合作
和其他开发者合作可以让你更好地了解代码。

他们可能会有不同的思路和理解方式,这可以让你更全面地了解代码的结构和实现方式。

以上是阅读项目代码的一些建议,希望对你有所帮助。

源码阅读:学习他人的优秀代码

源码阅读:学习他人的优秀代码

源码阅读:学习他人的优秀代码阅读他人的优秀代码是程序员成长过程中非常重要的一环,通过阅读他人的代码可以学习到更多的编程技巧和思维方式,从而提升自己的编程能力。

在本文中,我将向大家介绍我是如何通过阅读别人的代码来学习的,以及我是如何将所学应用到自己的编程实践中。

我将按照以下结构来展开论述:首先我将介绍我是如何选择优秀的代码来阅读的,其次我将讲述通过阅读别人的代码我学到了哪些编程技巧和思维方式,然后我会具体举例说明我是如何将所学应用到自己的编程实践中,最后我将总结整篇文章并表达对阅读优秀代码的看法。

选择优秀的代码进行阅读要想通过阅读别人的代码学到东西,首先就需要选择一些优秀的代码来阅读。

那么,如何选择优秀的代码呢?我个人的经验是,可以从以下几个方面来考虑。

首先,我会选择一些在业界有一定声望的开源项目或者优秀的开源工具来阅读。

这些项目通常由一些经验丰富的程序员或者团队维护,他们的代码质量通常比较高,而且代码中往往蕴含着一些值得学习的编程技巧和思维方式。

其次,我会选择一些已经被广泛应用和验证过的开源项目或者工具来阅读。

这些项目经过了市场的检验,其代码结构和编程方法往往是比较成熟的,通过阅读这些代码可以学到很多实用的编程技巧和经验。

另外,我也会选择一些技术领域的专家或者大牛的个人项目或者博客来阅读。

这些人通常在某个领域有着非常深厚的功底,他们的代码或者文章中往往蕴含着很多值得深入研究和学习的东西。

通过以上的选择标准,我能够找到一些非常有价值的代码来阅读,从而不断提升自己的编程能力。

学习他人的代码通过阅读他人的代码,我学到了很多宝贵的编程技巧和思维方式。

下面我将结合具体的例子来讲述我学到了哪些东西。

首先,通过阅读别人的代码,我学到了很多关于代码结构和模块化设计的技巧。

在一个优秀的代码中,通常会有良好的模块划分和组织,不同的功能模块会有清晰的接口和约定,这样可以使得代码更具有可读性和可维护性。

通过阅读他人的代码,我学到了如何进行合理的模块划分和组织,以及如何设计清晰的模块接口和约定。

如何进行快速阅读代码

如何进行快速阅读代码

如何进行快速阅读代码每个程序员所写的代码都有自己的风格,而我们在参考别人的代码的时候,如何能更快速更好地读懂和自己编程风格的代码呢?下面为你整理如何快速阅读代码,希望能帮到你。

快速阅读代码方法1、阅读源代码的说明文档,比如本例中的README, 作者写的非常的详细,仔细读过之后,在阅读程序的时候往往能够从README 文件中找到相应的说明,从而简化了源程序的阅读工作。

2、如果源代码有文档目录,一般为doc或者docs,最好也在阅读源程序之前仔细阅读,因为这些文档同样起了很好的说明注释作用。

3、从makefile文件入手,分析源代码的层次结构,找出哪个是主程序,哪些是函数包。

这对于快速把握程序结构有很大帮助。

4、从main函数入手,一步一步往下阅读,遇到可以猜测出意思来的简单的函数,可以跳过。

但是一定要注意程序中使用的全局变量(如果是C程序),可以把关键的数据结构说明拷贝到一个文本编辑器中以便随时查找。

5、分析函数包(针对C程序),要注意哪些是全局函数,哪些是内部使用的函数,注意extern关键字。

对于变量,也需要同样注意。

先分析清楚内部函数,再来分析外部函数,因为内部函数肯定是在外部函数中被调用的。

6、需要说明的是数据结构的重要性:对于一个C程序来说,所有的函数都是在操作同一些数据,而由于没有较好的封装性,这些数据可能出现在程序的任何地方,被任何函数修改,所以一定要注意这些数据的定义和意义,也要注意是哪些函数在对它们进行操作,做了哪些改变。

7、在阅读程序的同时,最好能够把程序存入到cvs之类的版本控制器中去,在需要的时候可以对源代码做一些修改试验,因为动手修改是比仅仅是阅读要好得多的读程序的方法。

在你修改运行程序的时候,可以从cvs中把原来的代码调出来与你改动的部分进行比较(diff命令), 可以看出一些源代码的优缺点并且能够实际的练习自己的编程技术。

8、阅读程序的同时,要注意一些小工具的使用,能够提高速度,比如vi中的查找功能,模式匹配查找,做标记,还有grep,find这两个最强大最常用的文本搜索工具的使用。

计算机代码阅读技巧

计算机代码阅读技巧

计算机代码阅读技巧在计算机编程领域,代码阅读是非常重要的技能之一。

无论是检查他人的代码还是回顾自己的代码,良好的代码阅读能力能够帮助我们更快地理解代码的功能和逻辑,同时也有助于我们识别潜在的问题和改进的空间。

本文将介绍几种有效的计算机代码阅读技巧,帮助读者提升代码阅读的效率和准确性。

一、了解代码结构在开始阅读代码之前,首要任务是了解代码的整体结构。

这可以通过阅读项目的文档、查看函数和类的命名以及浏览目录结构来实现。

理解代码的整体框架和组织方式有助于我们更好地理解代码的功能和模块之间的关系。

二、逐行阅读逐行阅读是代码阅读的基本方法。

通过仔细地阅读每一行代码,我们可以理解代码的具体实现。

在逐行阅读过程中,我们可以注意以下几个方面:1. 代码注释:仔细阅读代码中的注释能够帮助我们理解代码作者的意图,以及代码的某些关键部分。

2. 变量和函数命名:良好的命名规范能够提高代码的可读性。

通过仔细阅读变量和函数的命名,我们可以推测它们的用途和功能。

3. 控制流和条件语句:注意代码中的循环结构和分支条件,以便理解代码在不同情况下的执行路径。

三、运行和调试代码阅读代码时,我们可以结合运行和调试代码来加深对代码的理解。

通过运行代码,我们可以观察代码的实际输出,并验证我们对代码功能的理解是否准确。

同时,调试代码可以帮助我们逐步跟踪代码的执行过程,并解决可能出现的错误和问题。

四、使用注释和文档在阅读代码的过程中,我们可以使用注释和文档来帮助我们理解代码。

对于他人编写的代码,我们可以查看代码中的注释,了解代码作者的意图和解释。

如果代码有相应的文档或者说明文档,我们可以仔细阅读来了解代码的功能和使用方法。

五、利用调试工具和插件为了提高代码阅读的效率,我们可以利用各种调试工具和插件。

例如,代码编辑器通常提供代码导航和关键字高亮等功能,帮助我们更好地理解代码。

此外,调试器可以帮助我们逐步执行代码,观察代码的状态和变量的值,从而更深入地了解代码的执行过程。

别人的程序好难读

别人的程序好难读

别人的程序好难读,怎么办要哭了大家都说要多读别人的代码,自己基础不够,就要好好向别人学习。

好吧,很多人肯定也尝试着读别人的代码,但是觉得很吃力,累人累心。

之前我也写过一篇关于如何阅读代码的:别人家的代码,你会读吗?里面提到过要利用工具帮助自己阅读代码,今天就来给大家推荐推荐这些神奇的帮你有效阅读代码的工具。

1.文本编辑器或IDE许多文本编辑器提供了常见程序语言的语法及关键词标示功能。

这对于阅读来说,绝对能够起很大的作用。

有些文本编辑器(例如我常用的EditPlus及偶而使用的Notepad++),甚至能够自动列出某个原始档中所有定义的函式清单,更允许你直接从清单中选择函式,直接跳跃到该函式的定义位置。

这对于阅读程序代码的人来说,就提供了极佳的便利性。

因为在阅读程序代码时,最常做的事,就是随着程序中的某个控制流,将阅读的重心,从某个函式移至它所呼叫的另一个函式。

所以对程序人来说,阅读程序代码时最常做的事之一就是:找出某个函式位在那一个原始档里,接着找到该函式所在的位置。

好的IDE能够提供的协助就更多了。

有些能够自动呈现一些额外的信息,最有用的莫过于函式的原型宣告了。

例如,有些IDE支持当光标停留在某函式名称上一段时间后,它会以Tooltip的方式显示该函式的原型宣告。

对阅读程序代码的人来说,在看到程序代码中呼叫到某个函式时,可以直接利用这样的支持,立即取得和这个函式有关的原型信息,马上就能知道呼叫该函式所传入的各个自变量的意义,而不必等到将该函式的定义位置找出后,才能明白这件事。

2.grep除了选用好的文本编辑器或IDE之外,还有一个基本、但却极为有用的工具,它就是grep。

熟悉Unix操作系统的程序人,对grep这个公用程序多半都不陌生。

Grep最大的用途,在于它允许我们搜寻某个目录(包括递归进入所有子目录)中所有指定档案,是否有符合指定条件(常数字符串或正规表示式)档案。

倘若有的话,则能帮你指出所在的位置。

相关主题
  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

如何阅读别人代码code reading++++++++++++第一章: 导论++++++++++++1.要养成一个习惯, 经常花时间阅读别人编写的高品质代码.2.要有选择地阅读代码, 同时, 还要有自己的目标. 您是想学习新的模式|编码风格|还是满足某些需求的方法.3.要注意并重视代码中特殊的非功能性需求, 这些需求也许会导致特殊的实现风格.4.在现有的代码上工作时, 请与作者和维护人员进行必要的协调, 以避免重复劳动或产生厌恶情绪.5.请将从开放源码软件中得到的益处看作是一项贷款, 尽可能地寻找各种方式来回报开放源码社团.6.多数情况下, 如果您想要了解"别人会如何完成这个功能呢?", 除了阅读代码以外, 没有更好的方法.7.在寻找bug时, 请从问题的表现形式到问题的根源来分析代码. 不要沿着不相关的路径(误入歧途).8.我们要充分利用调试器|编译器给出的警告或输出的符号代码|系统调用跟踪器|数据库结构化查询语言的日志机制|包转储工具和Windows的消息侦查程序, 定出的bug的位置.9.对于那些大型且组织良好的系统, 您只需要最低限度地了解它的全部功能, 就能够对它做出修改.10.当向系统中增加新功能时, 首先的任务就是找到实现类似特性的代码, 将它作为待实现功能的模板.11.从特性的功能描述到代码的实现, 可以按照字符串消息, 或使用关键词来搜索代码.12.在移植代码或修改接口时, 您可以通过编译器直接定位出问题涉及的范围, 从而减少代码阅读的工作量.13.进行重构时, 您从一个能够正常工作的系统开始做起, 希望确保结束时系统能够正常工作. 一套恰当的测试用例(test case)可以帮助您满足此项约束.14.阅读代码寻找重构机会时, 先从系统的构架开始, 然后逐步细化, 能够获得最大的效益.15.代码的可重用性是一个很诱人, 但难以理解与分离, 可以试着寻找粒度更大一些的包, 甚至其他代码.16.在复查软件系统时, 要注意, 系统是由很多部分组成的, 不仅仅只是执行语句. 还要注意分析以下内容: 文件和目录结构|生成和配置过程,用户界面和系统的文档.18.可以将软件复查作为一个学习|讲授|援之以手和接受帮助的机会.++++++++++++++++++++第二章: 基本编程元素++++++++++++++++++++19.第一次分析一个程序时, main是一个好的起始点.20.层叠if-else if-...-else序列可以看作是由互斥选择项组成的选择结构.21.有时, 要想了解程序在某一方面的功能, 运行它可能比阅读源代码更为恰当.22.在分析重要的程序时, 最好首先识别出重要的组成部分.23.了解局部的命名约定, 利用它们来猜测变量和函数的功能用途.24.当基于猜测修改代码时, 您应该设计能够验证最初假设的过程. 这个过程可能包括用编译器进行检查|引入断言|或者执行适当的测试用例.25.理解了代码的某一部分, 可能帮助你理解余下的代码.26.解决困难的代码要从容易的部分入手.27.要养成遇到库元素就去阅读相关文档的习惯; 这将会增强您阅读和编写代码的能力.28.代码阅读有许多可选择的策略: 自底向上和自顶向下的分析|应用试探法和检查注释和外部文档, 应该依据问题的需要尝试所有这些方法.29.for (i=0; i<n; i++)形式的循环执行n次; 其他任何形式都要小心.30.涉及两项不等测试(其中一项包括相等条件)的比较表达式可以看作是区间成员测试.31.我们经常可以将表达式应用在样本数据上, 借以了解它的含义.32.使用De Morgan法则简化复杂的逻辑表达式.33.在阅读逻辑乘表达式时, 问题可以认为正在分析的表达式以左的表达式均为true; 在阅读逻辑和表达式时, 类似地, 可以认为正在分析的表达式以左的表达式均为false.34.重新组织您控制的代码, 使之更为易读.35.将使用条件运行符? :的表达式理解为if代码.36.不需要为了效率, 牺牲代码的易读性.37.高效的算法和特殊的优化确实有可能使得代码更为复杂, 从而更难理解, 但这并不意味着使代码更为紧凑和不易读会提高它的效率.38.创造性的代码布局可以用来提高代码的易读性.39.我们可以使用空格|临时变量和括号提高表达式的易读性.40.在阅读您所控制的代码时, 要养成添加注释的习惯.41.我们可以用好的缩进以及对变量名称的明智选择, 提高编写欠佳的程序的易读性.42.用diff程序分析程序的修订历史时, 如果这段历史跨越了整体重新缩排, 常常可以通过指定-w选项, 让diff忽略空白差异, 避免由于更改了缩进层次而引入的噪音.43.do循环的循环体至少执行一次.44.执行算术运算时, 当b=2n-1时, 可以将a&b理解为a%(b+1).45.将a<<n理解为a*k, k=2n.46.将a>>n理解为a/k, k=2n.47.每次只分析一个控制结构, 将它的内容看作是一个黑盒.48.将每个控制结构的控制表达式看作是它所包含代码的断言.49.return, goto, break和continue语句, 还有异常, 都会影响结构化的执行流程. 由于这些语句一般都会终止或重新开始正在进行的循环,因此要单独推理它们的行为.50.用复杂循环的变式和不变式, 对循环进行推理.51.使用保持含义不变的变换重新安排代码, 简化代码的推理工作.+++++++++++++++++++第三章: 高级C数据类型+++++++++++++++++++52.了解特定语言构造所服务的功能之后, 就能够更好地理解使用它们的代码.53.识别并归类使用指针的理由.54.在C程序中, 指针一般用来构造链式数据结构|动态分配的数据结构|实现引用调用|访问和迭代数据元素|传递数组参数|引用函数|作为其他值的别名|代表字符串|以及直接访问系统内存.55.以引用传递的参数可以用来返回函数的结果, 或者避免参数复制带来的开销.56.指向数组元素地址的指针, 可以访问位于特定索引位置的元素.57.指向数组元素的指针和相应的数组索引, 作用在二者上的运算具有相同的语义.58.使用全局或static局部变量的函数大多数情况都不可重入(reentrant).59.字符指针不同于字符数组.60.识别和归类应用结构或共用体的每种理由.61.C语言中的结构将多个数据元素集合在一起, 使得它们可以作为一个整体来使用, 用来从函数中返回多个数据元素|构造链式数据结构|映射数据在硬件设备|网络链接和存储介质上的组织方式|实现抽象数据类型|以及以面向对象的方式编程.62.共用体在C程序中主要用于优化存储空间的利用|实现多态|以及访问数据不同的内部表达方式.63.一个指针, 在初始化为指向N个元素的存储空间之后, 就可以作为N个元素的数组来使用.64.动态分配的内在块可以电焊工地释放, 或在程序结束时释放, 或由垃圾回收器来完成回收; 在栈上分配的内存块当分配它的函数退出后释放65.C程序使用typedef声明促进抽象, 并增强代码的易读性, 从而防范可移植性问题, 并模拟C++和Java的类声明行为.66.可以将typedef声明理解成变量定义: 变量的名称就是类型的名称; 变量的类型就是与该名称对应的类型.+++++++++++++++第四章: C数据结构+++++++++++++++67.根据底层的抽象数据类型理解显式的数据结构操作.68.C语言中, 一般使用内建的数组类型实现向量, 不再对底层实现进行抽象.69.N个元素的数组可以被序列for (i=0; i<N; i++)完全处理; 所有其他变体都应该引起警惕.70.表达式sizeof(x)总会得到用memset或memcpy处理数组x(不是指针)所需的正确字节数.71.区间一般用区间内的第一个元素和区间后的第一个元素来表示.72.不对称区间中元素的数目等于高位边界与低位边界的差.73.当不对称区间的高位边界等于低位边界时, 区间为空.74.不对称区间中的低位边界代表区间的第一个元素; 高位边界代表区间外的第一个元素.75.结构的数组常常表示由记录和字段组成的表.76.指向结构的指针常常表示访问底层记录和字段的游标.77.动态分配的矩阵一般存储为指向数组列的指针或指向元素指针的指针; 这两种类型都可以按照二维数组进行访问.78.以数组形式存储的动态分配矩阵, 用自定义访问函数定位它们的元素.79.抽象数据类型为底层实现元素的使用(或误用)方式提供一种信心的量度.80.数组用从0开始的顺序整数为键, 组织查找表.81.数组经常用来对控制结构进行高效编码, 简化程序的逻辑.82.通过在数组中每个位置存储一个数据元素和一个函数指针(指向处理数据元素的函数), 可以将代码与数据关联起来.83.数组可以通过存储供程序内的抽象机(abstract machine)或虚拟机(virtual machine)使用的数据或代码, 控制程序的运作.84.可以将表达式sizeof(x) / sizeof(x[0])理解为数组x中元素的个数.85.如果结构中含有指向结构自身|名为next的元素, 一般说来, 该结构定义的是单向链表的结点.86.指向链表结点的持久性(如全局|静态或在堆上分配)指针常常表示链表的头部.87.包含指向自身的next和prev指针的结构可能是双向链表的结点.88.理解复杂数据结构的指针操作可以将数据元素画为方框|指针画为箭头.89.递归数据结构经常用递归算法来处理.90.重要的数据结构操作算法一般用函数参数或模板参数来参数化.91.图的结点常常顺序地存储在数组中, 链接到链表中, 或通过图的边链接起来.92.图中的边一般不是隐式地通过指针, 就是显式地作为独立的结构来表示.93.图的边经常存储为动态分配的数组或链表, 在这两种情况下, 边都锚定在图的结点上.94.在无向图中, 表达数据时应该将所有的结点看作是等同的, 类似地, 进行处理任务的代码也不应该基于它们的方向来区分边.95.在非连通图中, 执行遍历代码应该能够接通孤立的子图.96.处理包含回路的图时, 遍历代码应该避免在处理图的回路进入循环.97.复杂的图结构中, 可能隐藏着其他类型的独立结构.+++++++++++++++++第五章: 高级控制流程+++++++++++++++++98.采用递归定义的算法和数据结构经常用递归的函数定义来实现.99.推理递归函数时, 要从基准落伍测试开始, 并认证每次递归调用如何逐渐接近非递归基准范例代码.100.简单的语言常常使用一系列遵循该语言语法结构的函数进行语法分析. 101.推理互递归函数时, 要基于底层概念的递归定义.102.尾递归调用等同于一个回到函数开始处的循环.103.将throws子句从方法的定义中移除, 然后运行Java编译器对类的源代码进行编译, 就可以容易地找到那些可能隐式地生成异常的方法.104.在多处理器计算机上运行的代码常常围绕进程或线程进行组织.105.工作群并行模型用于在多个处理器间分配工作, 或者创建一个任务池, 然后将大量需要处理标准化的工作进行分配.106.基于线程的管理者/工人并行模型一般将耗时的或阻塞的操作分配给工人子任务, 从而维护中心任务的响应性.107.基于进程的管理者/工人并行模型一般用来重用现有的程序, 或用定义良好的接口组织和分离粗粒度的系统模块.108.基于流水线的并行处理中, 每个任务都接收到一些输入, 对它们进行一些处理, 并将生成的输出传递给下一个任务, 进行不同的处理.109.竞争条件很难捉摸, 相关的代码常常会将竞争条件扩散到多个函数或模块; 因而, 很难隔离由于竞争条件导致的问题.110.对于出现在信号处理器中的数据结构操作代码和库调用要保持高度警惕. 111.在阅读包含宏的代码时, 要注意, 宏既非函数, 也非语句.112.do…while(0)块中的宏等同于控制块中的语句.113.宏可以访问在它的使用点可见的所有局部变量.114.宏调用可改变参数的值115.基于宏的标记拼接能够创建新的标记符.+++++++++++++++++第六章: 应对大型项目+++++++++++++++++116.我们可以通过浏览项目的源代码树—包含项目源代码的层次目录结构, 来分析一个项目的组织方式. 源码树常常能够反映出项目在构架和软件过程上的结构. 117.应用程序的源代码树经常是该应用程序的部署结构的镜像.118.不要被庞大的源代码集合吓倒; 它们一般比小型的专门项目组织得更出色. 119.当您首次接触一个大型项目时, 要花一些时间来熟悉项目的目录树结构. 120.项目的源代码远不只是编译后可以获得可执行程序的计算机语言指令; 一个项目的源码树一般还包括规格说明|最终用户和开发人员文档|测试脚本|多媒体资源|编译工具|例子|本地化文件|修订历史|安装过程和许可信息. 121.大型项目的编译过程一般声明性地借助依赖关系来说明. 依赖关系由工具程序, 如make及其派生程序, 转换成具体的编译行动.122.大型项目中, 制作文件常常由配置步骤动态地生成; 在分析制作文件之前, 需要先执行项目特定的配置.123.检查大型编译过程的各个步骤时, 可以使用make程序的-n开关进行预演. 124.修订控制系统提供从储存库中获取源代码最新版本的方式.125.可以使用相关的命令, 显示可执行文件中的修订标识关键字, 从而将可执行文件与它的源代码匹配起来.126.使用修订日志中出现的bug跟踪系统内的编号, 可以在bug跟踪系统的数据库中找到有关的问题的说明.127.可以使用修订控制系统的版本储存库, 找出特定的变更是如何实现的.128.定制编译工具用在软件开发过程的许多方面, 包括配置|编译过程管理|代码的生成|测试和文档编制.129.程序的调试输出可以帮助我们理解程序控制流程和数据元素的关键部分. 130.跟踪语句所在的地点一般也是算法运行的重要部分.131.可以用断言来检验算法运作的步骤|函数接收的参数|程序的控制流程|底层硬件的属性和测试用例的结果.132.可以使用对算法进行检验的断言来证实您对算法运作的理解, 或将它作为推理的起点.133.对函数参数和结果的断言经常记录了函数的前置条件和后置条件.134.我们可以将测试整个函数的断言作为每个给定函数的规格说明.135.测试用例可以部分地代替函数规格说明.136.可以使用测试用例的输入数据对源代码序列进行预演.+++++++++++++++++++第七章: 编码规范和约定+++++++++++++++++++137.了解了给定代码库所遵循的文件组织方式后, 就能更有效率地浏览它的源代码.138.阅读代码时, 首先要确保您的编辑器或优美打印程序的tab设置, 与代码遵循的风格规范一致.139.可以使用代码块的缩进, 快速地掌握代码的总体结构.140.对编排不一致的代码, 应该立即给予足够的警惕.141.分析代码时, 对标记为XXX, FIXME和TODO的代码序列要格外注意: 错误可能就潜伏在其中.142.常量使用大写字母命名, 单词用下划线分隔.143.在遵循Java编码规范的程序中, 包名(package name)总是从一个顶级的域名开始(例如, org, com), 类名和接口名由大写字母开始, 方法和变量名由小写字母开始.144.用户界面控件名称之前的匈牙利记法的前缀类型标记可以帮助我们确定它的作用.145.不同的编程规范对可移植构造的构成有不同的主张.146.在审查代码的可移植性, 或以某种给定的编码规范作为指南时, 要注意了解规范对可移植性需求的界定与限制.147.如果GUI功能都使用相应的编程结构来实现, 则通过代码审查可以轻易地验证给定用户界面的规格说明是否被正确地采用.148.了解项目编译过程的组织方式与自动化方式之后, 我们就能够快速地阅读与理解对应的编译规则.149.当检查系统的发布过程时, 常常可以将相应发行格式的需求作为基准.++++++++++++第八章:文档++++++++++++150.阅读代码时, 应该尽可能地利用任何能够得到的文档.151.阅读一小时代码所得到的信息只不过相当于阅读一分钟文档.152.使用系统的规格说明文档, 了解所阅读代码的运行环境.153.软件需求规格说明是阅读和评估代码的基准.154.可以将系统的设计规格说明作为认知代码结构的路线图, 阅读具体代码的指引.155.测试规格说明文档为我们提供可以用来对代码进行预演的数据.156.在接触一个未知系统时, 功能性的描述和用户指南可以提供重要的背景信息,从而更好地理解阅读的代码所处的上下文.157.从用户参考手册中, 我们可以快速地获取, 应用程序在外观与逻辑上的背景知识, 从管理员手册中可以得知代码的接口|文件格式和错误消息的详细信息. 158.利用文档可以快捷地获取系统的概况, 了解提供特定特性的代码.159.文档经常能够反映和提示出系统的底层结构.160.文档有助于理解复杂的算法和数据结构.161.算法的文字描述能够使不透明(晦涩, 难以理解)的代码变得可以理解. 162.文档常常能够阐明源代码中标识符的含义.163.文档能够提供非功能性需求背后的理论基础.164.文档还会说明内部编程接口.165.由于文档很少像实际的程序代码那样进行测试, 并受人关注, 所以它常常可能存在错误|不完整或过时.166.文档也提供测试用例, 以及实际应用的例子.167.文档常常还会包括已知的实现问题或bug.168.环境中已知的缺点一般都会记录在源代码中.169.文档的变更能够标出那些故障点.170.对同一段源代码重复或互相冲突的更改, 常常表示存在根本性的设计缺陷, 从而使得维护人员需要用一系列的修补程序来修复.171.相似的修复应用到源代码的不同部分, 常常表示一种易犯的错误或疏忽, 它们同样可能会在其他地方存在.172.文档常常会提供不恰当的信息, 误导我们对源代码的理解.173.要警惕那些未归档的特性: 将每个实例归类为合理|疏忽或有害, 相应地决定是否应该修复代码或文档.174.有时, 文档在描述系统时, 并非按照已完成的实现, 而是系统应该的样子或将来的实现.175.在源代码文档中, 单词gork的意思一般是指”理解”.176.如果未知的或特殊用法的单词阻碍了对代码的理解, 可以试着在文档的术语表(如果存在的话)|New Hacker’s Dictionary[Ray96]|或在Web搜索引擎中查找它们.177.总是要以批判的态度来看待文档, 注意非传统的来源, 比如注释|标准|出版物|测试用例|邮件列表|新闻组|修订日志|问题跟踪数据库|营销材料|源代码本身. 178.总是要以批判的态度来看待文档; 由于文档永远不会执行, 对文档的测试和正式复查也很少达到对代码的同样水平, 所以文档常常会误导读者, 或者完全错误.179.对于那些有缺陷的代码, 我们可以从中推断出它的真实意图.180.在阅读大型系统的文档时, 首先要熟悉文档的总体结构和约定.181.在对付体积庞大的文档时, 可以使用工具, 或将文本输出到高品质输出设备上, 比如激光打印机, 来提高阅读的效率.++++++++++++++第九章: 系统构架++++++++++++++182.一个系统可以(在重大的系统中也确实如此)同时出多种不同的构架类型. 以不同的方式检查同一系统|分析系统的不同部分|或使用不同级别的分解, 都有可能发现不同的构架类型.183.协同式的应用程序, 或者需要协同访问共享信息或资源的半自治进程, 一般会采用集中式储存库构架.184.黑板系统使用集中式的储存库, 存储非结构化的键/值对, 作为大量不同代码元件之间的通信集线器.185.当处理过程可以建模|设计和实现成一系列的数据变换时, 常常会使用数据流(或管道—过滤器)构架.186.在批量进行自动数据处理的环境中, 经常会采用数据流构架, 在对数据工具提供大量支持的平台上尤其如此.187.数据流构架的一个明显征兆是: 程序中使用临时文件或流水线(pipeline)在不同进程间进行通信.188.使用图示来建模面向对象构架中类的关系.189.可以将源代码输入到建模工具中, 逆向推导出系统的构架.190.拥有大量同级子系统的系统, 常常按照分层构架进行组织.191.分层构架一般通过堆叠拥有标准化接口的软件组件来实现.192.系统中每个层可以将下面的层看作抽象实体, 并且(只要该层满足它的需求说明)不关心上面的层如何使用它.193.层的接口既可以是支持特定概念的互补函数族, 也可以是一系列支持同一抽象接口不同底层实现的可互换函数.194.用C语言实现的系统, 常常用函数指针的数组, 表达层接口的多路复用操作.195.用面向对象的语言实现的系统, 使用虚方法调用直接表达对层接口的多嘴复用操作.196.系统可以使用不同的|独特的层次分解模型跨各种坐标轴进行组织.197.使用程序切片技术, 可以将程序中的数据和控制之间依赖关系集中到一起.198.在并发系统中, 一个单独的系统组件起到集中式管理器的作用, 负责启动|停止和协调其他系统进程和任务的执行.199.许多现实的系统都会博采众家之长. 当处理此类系统时, 不要徒劳地寻找无所不包的构架图; 应该将不同构架风格作为独立但相关的实体来进行定位|识别并了解.200.状态变迁图常常有助于理清状态机的动作.201.在处理大量的代码时, 了解将代码分解成单独单元的机制极为重要.202.大多数情况下, 模块的物理边界是单个文件|组织到一个目录中的多个文件或拥有统一前缀的文件的集合.203.C中的模块, 由提供模块公开接口的头文件和提供对应实现的源文件组成.204.对象的构造函数经常用来分配与对象相关的资源, 并初始化对象的状态. 函数一般用来释放对象在生命期中占用的资源.205.对象方法经常使用类字段来存储控制所有方法运作的数据(比如查找表或字典)或维护类运作的状态信息(例如, 赋给每个对象一个标识符的计数器).206.在设计良好的类中, 所有的字段都应在声明为private, 并用公开的访问方法提供对它们的访问.207.在遇到friend声明时, 要停下来分析一下, 看看绕过类封装在设计上的理由.208.可以有节制地用运算符增强特定类的可用性, 但用运算符重载, 将类实现为拥有内建算术类型相关的全部功能的类实体, 是不恰当的.209.泛型实现不是在编译期间通过宏替换或语言所支持的功能(比如C++模板和Ada的泛型包)来实现, 就是在运行期间通过使用数据元素的指针和函数的指针|或对象的多态性实现.210.抽象数据类型经常用来封装常用的数据组织方案(比如树|列表或栈), 或者对用户隐藏数据类型的实现细节.211.使用库的目的多种多样: 重用源代码或目标代码, 组织模块集合, 组织和优化编译过程, 或是用来实现应用程序各种特性的按需载入.212.大型的|分布式的系统经常实现为许多互相协作的进程.213.对于基于文本的数据储存库, 可以通过浏览存储在其中的数据, 破译出它的结构.214.可以通过查询数据字典中的表, 或使用数据库专有的SQL命令, 比如show table, 来分析关系型数据库的模式.215.识别出重用的构架元素后, 可以查找其最初的描述, 了解正确地使用这种构架的方式, 以及可能出现的误用.216.要详细分析建立在某种框架之上的应用程序, 行动的最佳路线就是从研究框架自身开始.217.在阅读向导生成的代码时, 不要期望太高, 否则您会感到失望.218.学习几个基本的设计模式之后, 您会发现, 您查看代码构架的方式会发生改变: 您的视野和词汇将会扩展到能够识别和描述许多通用的形式.219.频繁使用的一些模式, 但并不显式地指出它们的名称, 这是由于构架性设计的重用经常先于模式的形成.220.请试着按照底层模式来理解构架, 即使代码中并没有明确地提及模式. 221.大多数解释器都遵循类似的处理构架, 围绕一个状态机进行构建, 状态机的操作依赖于解释器的当前状态|程序指令和程序状态.222.多数情况下, 参考构架只是为应用程序域指定一种概念性的结构, 具体的实现并非必须遵照这种结构.。

相关文档
最新文档