适用于更大项目的理想文档集

Question

如果你得到一份工作，就像拥有200k代码的2岁项目一样，你就可以获得一个麻烦的10个包3个组件UML图和2页文档吗？

您认为合理地快速获取数据的理想数量是多少，或者是否有任何建议可以帮助我理解那些有时会产生5k行的类的无证项目。

感谢您的回答。

Answer 1

你有我的同情:)我认为“如何理解新的应用程序”这个更普遍的问题会成为一个很好的社区维基问题

首先阅读来源。 200K线并不是那么大。

快速阅读来源。这不是尝试学习所有内容，而是要了解结构，提到关键事项，命名方案等等。我们的想法是提出一个事物的概念，以便在证明有必要的时候回过头来进行更详细的翻找。

在我正在做的类似情况下阅读代码时，我被问过一次。这是一个有趣的问题，我不得不考虑答案。就我而言，我的目标是了解应用程序的关键流程，关键数据结构以及如何管理和更改它们。

您知道应用程序的功能或应该做什么吗？它有用吗？它已经发布了吗？还是仍在开发中？它甚至构建了吗？

有没有测试套件？如果是这样，请查看这些内容以了解功能。如果没有，请开始写一些，因为您需要这些，以确保您所做的任何更改都是正确的。

您需要对该应用程序做什么？添加功能或修复缺陷？在任何一种情况下，重现“缺陷”（如果它是一个特性，写一个由于缺少特征而失败的测试用例。如果是缺陷，写一个由于缺陷而失败的测试用例）。

然后开始跟踪执行以查看相关代码的位置。

重复直到熟悉。

Answer 2

我在这里回应其他评论，但我也开始用doxygen直接记录源代码 - 它真的有助于'首先看到'源文件的文件结构，然后你可以开始为应用程序范围的源代码和库代码添加注释。

Answer 3

好吧，我不得不说这取决于代码的评论程度。如果代码不是自我记录的，那么额外的文档肯定是必不可少的。另一方面，如果代码已被彻底评论，函数名称和变量是不言自明的，我老实说，如果提供了任何额外的文档，我甚至可能不会费心，但那只是我。