阅读代码经验

1.运行代码，看日志。有条件一定要把代码运行起来，可以直观的体会代码的功能，以及运行流程。当然，有时让代码运行起来并不容易，需要对各种环境，需要读通各级Makefile，脚本，和设置环境变量等，还需要各种硬件。

2.使用代码阅读工具，推荐vscode 和 souce insinght。

    两款工具用起来还是vscode比较舒服，不过vscode搜索起来感觉比较慢，而SI界面不太美观。

       2.1全局搜索功能。

       2.2 折叠功能。把不用的代码折叠起来，减少视觉和心理负担。

       2.3 symbol框，快速了解函数层次。

3.相关文档。

       文档是了解代码功能最直观的手段。接手一份代码，最好了解是否有需求文档、场景文档和设计文档等。其中设计文档无疑是最为重要，可以帮助理解设计思路，理清代码结构。可惜不少初创公司，甚至某些规模不小的公司都不重视形成文档，工作传承靠口口相传，找不到相关有效文档的情况时而发生，这时只能心疼读者一秒，只能找相关的同事了解下情况吧。

4.总分，分总。抓住主线，扩散到分支，从分支汇聚到总线。

      阅读代码我觉得跟学生时代的阅读有些类似。抓住结构，可以帮助我们认识代码。先总后分，就像先看书的简介和篇章介绍，先了解代码的整体结构，运行的大致流程，先不去抠细节，可以帮助我们建立大局观；有时我们接手一项紧急的任务，也根本没有时间细看，只能抓重点。而从分到总，我们可以深入各个章节，了解各个部分的业务特性。

5.勤做笔记，勤整理

    人的大脑容量有限，深入代码之后，很容易就会忘记前面的内容，这时做笔记是很好的手段。可以把代码相关的内容分类到问价中，把获取的信息汇总。看代码的时候记录函数调用关系，主要结构体等，可以更好地把握代码流程，减少记忆负担。

    同时，对于经常出现而记不起意义的结构体成员可以为其做注释。另外，当看到代码中一些你不会的知识，可以百度一下，然后记录起来，形成个人的知识库。