如何快速熟悉项目代码?
- 跑测试用例,打断点看核心流程;
- 查看系统提供了哪些api接口;
- 将理解的业务知识的文档化,复杂的业务流程画流程图;
首先,把公开的软件实体(模块、类、函数、常量、全局变量等)的规格整理出来。通过软件实体的规格、说明文档、example、unit test 等信息,我们根据这些已知信息,甚至包括软件实体的名字本身背后隐含的语义理解,我们可以初步推测出各个软件实体的业务范畴,以及它们之间的关系。
如果你能够找到之前做过这块业务的人,不要犹豫,尽可能找到他们并且争取一个小时左右的交流机会,并提前准备好自己遇到迷惑的问题列表。这会大幅缩短你理解整个系统的过程。
最后,确保我们正确理解了系统,就需要将结论写下来,形成文档。
如果我们是接手一个新的业务系统,我们也没有精力立刻把所有细节都搞清楚。这时候我们需要梳理的是关键业务流程。阅读代码的结果,有时不一定仅仅是架构设计文档的补充与完善。我们有时也会顺手修改几行代码。不管多自信,有改动就需要补全相关的单元测试,确保修改代码的条件边界都被覆盖。
接手代码还没有搞懂就改,会出大问题。所以阅读代码是工作的重要组成部分。
浙公网安备 33010602011771号