不完全遵循项目UML图表中描述的内容

Question

这让我困惑了很长一段时间。我有一个已经完成的应用程序，但由于客户端正在寻找它的详细文档，我现在必须创建图表。令我感到困惑的一点是，每当我制作图表时，图表似乎与我的编码看起来不完全相同。 例如，在我的类图上，我有一个名为'announcements'的类，在该类下面是getAnnouncements（）的方法。但是在实际编码中，你永远不会找到一个名为getAnnoucements（）的方法，因为我选择不为它创建一个方法，而是将代码直接放在主类上。我知道这不是一个好的编码实践，但如果呢？所以这些是我的问题：我真的必须遵循类图中的内容吗？或者，由于我正在使用逆向工程，我是否必须遵循代码中的内容并制作图表？

Answer 1

如果您正在编写文档并且您在代码级别创建了UML，请按照代码中的实际内容进行操作。

这种方法的好处是

• 你的图表与你的代码相似
• 您（和您的客户）将能够识别不良代码的部分（即不遵循各种标准） - 就像您描述的那样。它有机会在未来改进它

缺点是您可能需要更正自动生成的图表。每次生成它。