究竟应该在类图中表示什么

Question

正在编写我的Bsc IT年终计划项目，并且对什么确实应该在类图中表示什么以及哪些不是真正必需的内容感到困惑。我的情况是使用spring with MVC+hibernate。我只是用他们之间的关系代表我的实体类。现在我想创建一个活动图，我意识到MVC controller类可能涉及我没有包括在我的class diagram。

第二个问题：间activity，sequence和data flowdiagrams哪一个更好地document a flow of process（必要不是数据）。假设我想记录authentication作品（含signup，verification和login组成）

非常感谢

Answer 1

UML是如何交流的工具。你的目标是让你的意图对其他开发者清楚。需要多少细节才能使事情清楚取决于你想要沟通的内容。

如果您将UML视为工程图，您可能需要每个类，每个方法签名，每个调用。你可以拿这样的东西，把它放在开发人员的桌子上，让他们编码你的视觉。我认为这很少是这种情况。与编写代码一样多的工作，但它不是可测试的。

我认为将类和它们的交互作用包含在一个足够简单的级别以显示高级别意图是比较现实的。让开发人员填写其余的细节。

Answer 2

类图显示类和每个类的重要成员变量和函数之间的关系。这样，他们就可以显示角色和职责，从而使设计人员可以确定哪些软件模块应包含哪些功能。在使用继承时，它们对于显示层次结构非常有用，浏览代码时需要花费更长时间才能识别。对于属性和方法，显示您的受众所需的详细信息量。

我喜欢有多个协作类/组件达到目的时的顺序图。每个序列只显示一个场景，因此具有先决条件，单个流程序列（例如，不代表决策）和后置条件。活动图更适合于显示具有决策的顺序算法，错误处理等。如果存在合作和同步点，我还会在一个图中使用多个活动。