面向对象软件设计说明书模板[2]

2007-9-20　网友评论 0 条　点击进入论坛

　　在其中应该包含所有的系统对象。这些对象都是从理解需求后得到的。要明确哪些应该、哪些不应该被放进图中。

　　所有对象之间的关联必须被确定并且必须指明联系的基数(一对一、一对多还是多对多，0..1，*，1..*)。聚合和继承关系必须清楚地确定下来。每个图必须附有简单的说明。

　　可能经过多次反复之后才能得到系统的正确的对象模型。

　　6 对象描述

　　在这个部分叙述每个对象的细节，它的属性、它的方法。在这之前必须从逻辑上对对象进行组织。你可能需要用结构图把对象按子系统划分好。

　　为每个对象做一个条目。在系统对象模型中简要的描述它的用途、约束(如只能有一个实例)，列出它的属性和方法。如果对象是存储在持久的数据容器中，标明它是持久对象，否则说明它是个临时对象(transient object)。

　　对每个对象的每个属性详细说明：名字、类型，如果属性不是很直观或者有约束(例如，每个对象的该属性必须有一个唯一的值或者值域是有限正整数等)。

　　对每个对象的每个方法详细说明：方法名，返回类型，返回值，参数，用途以及使用的算法的简要说明(如果不是特别简单的话)。如果对变量或者返回值由什么假定的话，Pre-conditions和Post-conditions必须在此说明。列出它或者被它调用的方法需要访问或者修改的属性。最后，提供可以验证实现方法的测试案例。

　　6.1 子系统1中的对象

　　6.1.1 对象：对象1

　　用途：

　　约束：

　　持久性：

　　6.1.1.1 属性描述：

　　1. 属性：属性1

　　类型：

　　描述：

　　约束：

　　2. 属性：属性2

　　6.1.1.2 方法描述：

　　1. 方法：方法1

　　返回类型：

　　参数：

　　返回值：

　　Pre-Condition：

　　Post-Condition：

　　读取/修改的属性：

　　调用的方法：

　　处理逻辑：

　　测试例：用什么参数调用该方法，期望的输出是什么……

　　7 动态模型

　　这部分的作用是描述系统如何响应各种事件。例如，可以建立系统的行为模型。一般使用顺序图和状态图。

　　确定不同的场景(Scenario)是第一步，不需要确定所有可能的场景，但是必须至少要覆盖典型的系统用例。不要自己去想当然地创造场景，通常的策略是描述那些客户可以感受得到的场景。

　　7.1 场景(Scenarios)

　　对每个场景做一则条目，包括以下内容：

　　场景名：给它一个可以望文生义的名字

　　场景描述：简要叙述场景是干什么的以及发生的动作的顺序。

　　顺序图：描述各种事件及事件发生的相对时间顺序。

　　7.1.1 场景：场景1

　　描述：

　　动作1

　　动作2

　　7.2 状态图

　　这部分的内容包括系统动态模型重要的部分的状态图。可能你想为每个对象画一个状态图，但事实上会导致太多不期望的细节信息，只需要确定系统中一些重要的对象并为之提供状态图即可。

　　7.2.1 状态图1：

　　8 非功能性需求

　　在这个部分，必须说明如何处理需求文档中指定的非功能性需求。尽可能客观地评估系统应付每一个非功能性的需求的能力程度。如果某些非功能性需求没有完全在设计的系统中实现，请务必在此说明。另外，你也需要对系统将来的进化作一个估计并描述本设计如何使系统能够适应这些可预见的变化。

　　9 辅助文档

　　提供能帮助理解设计的相应文档。

　　10 词汇索引

已有 0 位对此文章感兴趣的网友发布了看法　

我来评两句	登录邮箱：密码：
请您在这里发表您的个人看法，发言时请各位遵纪守法并注意语言文明！
	匿名发表

今日推荐

技术文库(共有 46473 篇文章)

产品技术答疑

重点推荐