作者 | Prahlad Yeri
出品 | CSDN（ID：CSDNnews）
作为程序员我工作过的大多数 IT 公司都是 IT 服务行业。几乎没有什么新鲜的工作，大部分时间我们都不得不维护或修复其他工程师写的代码，这些工程师有时候甚至已经跑路了。
因此，我们必须要能够适应阅读和调试现有的代码。本文我将根据我的经验，给出阅读和调试代码的一般方式并和技巧：
事先准备好所有可以找到的背景材料和文档
当你甚至都不知道这些代码是关于啥的以及这些代码是用来干啥的时候，阅读别人的代码就会非常痛苦。你可能需要从设计人员，测试人员，客户，领域专家等各种头衔的人那里收集信息。你可能还需要在公司的内网或文档系统里进行搜索资料。如果你能很幸运地找到之前版本的测试用例，那就更好了！
研究后端数据库 (表、视图等)
大约 90% 的现有代码的功能是从某处获取输入并将其处理以后放入数据库的表中。或者从数据库表获取数据，或者将其展示到用户屏幕上，或者作为 API 请求的响应返回。先理解后端数据结构可以帮助你后面理解代码的意图。然而，有时候后端数据库并不总能看得的！我有很多次，因为数据库和服务器访问权限尚未提供给我，而不得不先开始研究代码！但是，如果你具有这种访问权限，可以通过运行 SQL 语句来研究后端表。
先浏览一下模块/类，不要逐个进入每个函数/过程
假设你遵循了前两个步骤，那么现在你至少应该对应用程序有了一定的了解。现在，控制自己要逐行阅读所有代码的冲动，先去了解应用程序的一些 “惯例” 。先从应用程序的入口开始（在 Java / C＃中为 void 主函数，在其他语言中为类似的等效函数），从程序的入口着手梳理源码。浏览代码时，多关注下各种注释，有时注释里会包含很多有价值的信息。继续在记事本中记下代码的作用。
像下面给出的示例这样写出伪代码，对理解代码非常有帮助：
<code>start: main function/<code><code>input: distro_file/<code>
<code>call check_pattern: distro_file/<code>
<code>if not check_successful:/<code><code> print("pattern doesn't match with any known distros")/<code><code> exit/<code>
<code>call verify(pattern_resul/<code>
以上伪代码是我编写的名为 distro-verify 开源 python 应用时写的一个简单示例。
开始调试代码，必要时重复多次
调试是每一个称职的程序员生存之道！正如你需要控制一匹不稳定的马一样，你也需要使用调试工具调试源代码来保证其正确性。尽管单步调试是一种很好的，甚至是首先的方法，但是你不一定要在 IDE 中对源码打断点进行单步调试。你还可以在代码中的重要位置添加打印语句来调试代码。调试代码的次数越多，你就越能理解它的作用。在调试过程中，你需要仔细了解代码的每一个细节。
尝试各种输入和变化
通常，测试人员、设计人员或者文档会告诉你输入应该是什么。在对代码进行调试的过程中，你要不断记录自己不理解的内容 (也许设计师或领域专家稍后会帮你解答这一部分疑问)。你还可以尝试各种输入，观察应用程序对每个输入做了什么。如果你有测试用例，运行应用程序的每个测试用例看看他们是否能够通过。
以上是一些非常通用的技巧，但是特定代码可能有一些特殊性，这些特殊情况可能需要一些额外的步骤。请在下方留言告诉我你阅读别人代码时是怎样做的。
原文链接：
https://freelancemag.blogspot.com/2020/02/cracking-chaos-tips-on-reading-and.html
本文为CSDN翻译文章，转载请注明出处。
閱讀更多 CSDN 的文章
