理解软件系统

Question

我最近成为了一个复杂的嵌入式项目团队的一员，我将为该团队开发一个部分。对于我负责的部分，只有旧的代码，没有太多的文档。

我渴望有一个好的开始，但害羞和害怕表现得愚蠢使我很难提出问题。如何提问？

我想问你们是用什么技术来理解一个项目的？我的意思是，有许多技术细节，一个人必须记住并保持在上下文中，以便进行设计。你阅读了代码并获得了一些事实，但如何继续前进呢？例如，您阅读了代码和文档，得到了一些事实A和事实B。如何得出适当的结论X，你可能需要也可能不需要考虑事实C和D？

Answer 1

阅读代码是通过编写文档来平衡的。

编写您的替补人员将需要的文档。想象一下，有人知道的比你少。给那个人解释一下。

当你不能向你的继任者解释一些事情时，问一些问题。

当你有了一个完整的描述，你就会“了解”系统。

你将会制作出完整的文档。

Answer 2

如果没有足够的文档，并且代码文档记录得很差且编写得很差，那么读取代码就会特别困难。我想现在最好的方法是找到代码的入口点，然后慢慢地理解它的流程和它使用的数据。我会一直留心

1. Structure -是否存在任何实体/系统分区？它们在代码中的什么位置(以及如何)相互通信？
2. 数据-使用哪种结构来保存全局数据？如何访问和保存数据？
3. 如果您正在使用C或C++，了解内存是如何处理的也很重要，对于C++ (以及其他相关的非托管内存OOP语言，我猜)，对象所有权是如何包含的。
4. 由于它是嵌入式项目，是否使用了任何非标准代码或编码构造？

Answer 3

您没有提到存在哪些类型的测试。如果有测试用例，修改它们并跟踪这将如何影响最终结果。