如何阅读源代码

今天我们来简单的谈谈应该如何去阅读源代码。阅读源代码是每个程序员都要做的事情,毕竟成为master的先前一步,就是 follow the master

学会如何使用

要想知道一个东西怎么实现的,我们首先要有一个大概的认知,例如,是什么,大概是怎么用的。所以我们需要先去熟悉这个项目,通常我们可以这样做:

  • 读文档

阅读已有的,优秀的文档,可以加快了解整个项目的使用,坑和架构,这样可以快速建立起自己对该项目的认知。

  • 写demo

如果阅读的是一个库的代码呢?我们可以引用这个库,写一些简单的demo,这也是为了加快我们建立对项目的认知。

  • 熟悉如何使用

接下来要做的事情就是多写demo,多使用,当使用该项目到达一定程度的时候,就可以开始阅读源代码,而阅读源代码本身又可以促进对项目的熟悉程度。但是,在什么时候应当开始阅读源代码,因人而异,并没有一个通用的度,而且会因为自身经验的积累而变化。我个人建议当可以写出demo并且知道demo的每一行都在做什么的时候,就可以开始一边阅读源代码了,如果发现看不懂,则可以继续加深对项目使用的熟悉程度,然后再次尝试。

通常注意,项目越大,开始阅读源代码所面临的难度其实会越高,一定要有信心。

接下来我们主要聊聊一些常用的阅读源代码的技巧。

从main函数入手

你的程序是怎么运行的?一定是从某个入口点(entrypoint)开始执行。例如 Python 可能是 if __name__ == "__main__" 或者 python 后面接的那个脚本名,例如 Go 通常是 main 函数,C亦然。如果是阅读一个已有的项目而非库,那么我们可以从入口函数开始跟踪代码,看具体都做了一些什么,如果是一个库,那么我们可以从我们的demo的入口处开始跟踪源代码。

但是注意,从上而下和从下而上这两种阅读源代码的方法论,并没有哪一种更好,从上而下是从概貌到细节,从下而上是从实现细节到概况。通常来说,都是结合两者,但是我个人通常以自上而下为主,了解了概貌之后,才会去了解具体的实现。

top Created with Sketch.