当您继承一个庞大的、没有文档的代码库时，您如何着手理解它？

Question

Accepted Answer

当您继承一个没有文档的代码库时，要克制住从头到尾读完每一个文件或重构看起来很丑的代码的冲动。您还不了解它，对理解不透彻的代码进行早期重构是导致故障的方式。目标是快速地从实际行为（而不是猜测）建立一个准确的心智模型。

## 实用的方法

- **首先在本地运行它。** 让它编译和运行可以让您在读任何逻辑代码之前了解堆栈、依赖关系和设置的痛点。
- **跟踪一个真实的用户流程从头到尾。** 选择具体的东西（登录、结账、报告）并追踪它从入口点到数据库再返回。深入理解一个流程胜过粗略浏览十个。
- **阅读数据模型。** schema 和核心域对象揭示了系统实际上做什么以及概念如何相互关联，通常比代码更诚实。
- **找到入口点。** Routes、controllers、message consumers、cron jobs、main 函数。这些是进入系统的门。
- **使用 tests 和日志确认行为。** 添加日志行或断点并观察现实，而不是做假设。现有的 tests 记录了预期的行为。
- **与了解它的人交流。** 与经历过决策的人谈三十分钟可以节省数天的考古工作。询问*为什么*，而不仅仅是*什么*。
- **边走边写下地图。** 一份关于模块、流程和陷阱的运行文档将您的工作转化为下一个人和您未来的自己可以重用的东西。

## 要避免的事项

不要在理解之前重构。不要相信注释而忽视行为。不要试图一次在脑海中容纳整个系统；深入理解重要部分胜过到处都很浅的广度。

## 为什么这很重要

大部分工程工作发生在别人写的代码中。能够快速安全地建立对不熟悉系统的心智模型的技术主管会释放整个团队，准确地确定工作范围，并避免更改他们还不理解的东西这个代价高昂的错误。