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

2024-09-02 16:58

本文主要是介绍贺利坚-如何阅读代码(已阅加重点划),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

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

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

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

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

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

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

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

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

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

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

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

这篇关于贺利坚-如何阅读代码(已阅加重点划)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1130534

相关文章

Java调用DeepSeek API的最佳实践及详细代码示例

《Java调用DeepSeekAPI的最佳实践及详细代码示例》:本文主要介绍如何使用Java调用DeepSeekAPI,包括获取API密钥、添加HTTP客户端依赖、创建HTTP请求、处理响应、... 目录1. 获取API密钥2. 添加HTTP客户端依赖3. 创建HTTP请求4. 处理响应5. 错误处理6.

使用 sql-research-assistant进行 SQL 数据库研究的实战指南(代码实现演示)

《使用sql-research-assistant进行SQL数据库研究的实战指南(代码实现演示)》本文介绍了sql-research-assistant工具,该工具基于LangChain框架,集... 目录技术背景介绍核心原理解析代码实现演示安装和配置项目集成LangSmith 配置(可选)启动服务应用场景

Python中顺序结构和循环结构示例代码

《Python中顺序结构和循环结构示例代码》:本文主要介绍Python中的条件语句和循环语句,条件语句用于根据条件执行不同的代码块,循环语句用于重复执行一段代码,文章还详细说明了range函数的使... 目录一、条件语句(1)条件语句的定义(2)条件语句的语法(a)单分支 if(b)双分支 if-else(

MySQL数据库函数之JSON_EXTRACT示例代码

《MySQL数据库函数之JSON_EXTRACT示例代码》:本文主要介绍MySQL数据库函数之JSON_EXTRACT的相关资料,JSON_EXTRACT()函数用于从JSON文档中提取值,支持对... 目录前言基本语法路径表达式示例示例 1: 提取简单值示例 2: 提取嵌套值示例 3: 提取数组中的值注意

CSS3中使用flex和grid实现等高元素布局的示例代码

《CSS3中使用flex和grid实现等高元素布局的示例代码》:本文主要介绍了使用CSS3中的Flexbox和Grid布局实现等高元素布局的方法,通过简单的两列实现、每行放置3列以及全部代码的展示,展示了这两种布局方式的实现细节和效果,详细内容请阅读本文,希望能对你有所帮助... 过往的实现方法是使用浮动加

JAVA调用Deepseek的api完成基本对话简单代码示例

《JAVA调用Deepseek的api完成基本对话简单代码示例》:本文主要介绍JAVA调用Deepseek的api完成基本对话的相关资料,文中详细讲解了如何获取DeepSeekAPI密钥、添加H... 获取API密钥首先,从DeepSeek平台获取API密钥,用于身份验证。添加HTTP客户端依赖使用Jav

Java实现状态模式的示例代码

《Java实现状态模式的示例代码》状态模式是一种行为型设计模式,允许对象根据其内部状态改变行为,本文主要介绍了Java实现状态模式的示例代码,文中通过示例代码介绍的非常详细,需要的朋友们下面随着小编来... 目录一、简介1、定义2、状态模式的结构二、Java实现案例1、电灯开关状态案例2、番茄工作法状态案例

nginx-rtmp-module模块实现视频点播的示例代码

《nginx-rtmp-module模块实现视频点播的示例代码》本文主要介绍了nginx-rtmp-module模块实现视频点播,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习... 目录预置条件Nginx点播基本配置点播远程文件指定多个播放位置参考预置条件配置点播服务器 192.

CSS自定义浏览器滚动条样式完整代码

《CSS自定义浏览器滚动条样式完整代码》:本文主要介绍了如何使用CSS自定义浏览器滚动条的样式,包括隐藏滚动条的角落、设置滚动条的基本样式、轨道样式和滑块样式,并提供了完整的CSS代码示例,通过这些技巧,你可以为你的网站添加个性化的滚动条样式,从而提升用户体验,详细内容请阅读本文,希望能对你有所帮助...

深入解析Spring TransactionTemplate 高级用法(示例代码)

《深入解析SpringTransactionTemplate高级用法(示例代码)》TransactionTemplate是Spring框架中一个强大的工具,它允许开发者以编程方式控制事务,通过... 目录1. TransactionTemplate 的核心概念2. 核心接口和类3. TransactionT