这篇文章主要介绍下笔者看源码的一些心得和方式,由于笔者看的大部分是前端项目,当然也看过一些其它领域的源码,不过不多,所以内容主要还是以前端项目为主
了解和熟悉
在准备看一个开源项目源码的时候先去熟悉下这个项目的背景、功能以及相应的API。这步为了理解整个项目的功能做准备,也是为了后面重点看哪些模块做准备
查看项目的immer
查看项目整体的文件结构。比如下面提到一些重点需要查看的文件
package.json,可以从这个文件看到整个项目的入口文件、开发/测试/发布编译的各种命令,也可以了解到项目的依赖库、工具以及框架等等。
webpack/gulp/rollup配置文件,从这个文件里面可以看到项目整体的工具配置,也包含入口文件以及编译之后的代码文件,以及一些配置项的功能
知道一些默认命名的文件规则,比如
dist,表示编译之后的源文件
src,源代码文件
* index.xx,一般会用来作为前端的入口文件
* app.xx、server.xx,一般会用来做后端的入口文件
static,静态文件,前端项目一般都会用来作为给浏览器运行的入口文件
test,测试用例文件夹
* e2e,端对端测试
* unit,单元测试
… 这期间哪怕你遇到一些文件你不知道有什么用,有2个方式可以了解到
直接用google搜该文件名,往往能找到相关答案,比如**.eslintrc.js**
进去看