面向对象软件的文档编制.docVIP

A.1综述 在一个面向对象的软件系统建模中，一般地说，应产生下列文档： 总体说明文档； 用况图文档； 类图文档； 顺序图文档， 协作图文档； 状态图文档； 活动图文档； 构件图文档； 部署图文档； 其中有的文档有时会引人包图来管理信息组织的复杂性。 开发者也可根据所承担项目的实际情况，灵活取舍或增补。 当开发者强调过程控制时，也可以形成需求定义文档、分析文档和设计文档等。 其中每种文档的内容包含一个或多个上面提到的各种图文档。 A.2总体说明文档 以文本方式，对整个系统作一些必要的说明。内容包括系统的目标、意义、应用范围、项目背景和文档组成等。但不必对系统的总体进行详细地说明，只需作提纲掣领式的简单介绍。另外，还要说明系统的建模文档由哪几种具体的文档组成、每种文档的份数以及对各种文档的组织等。 A.3用况图文档 A.3.1图形文档 即所绘制的用况图。 A.3.2文字说明 用况图文档由以下部分组成：用况图综述、参与者描述、用况描述、用况图中元素间的关系描述和其他与用况图有关的说明。 A.3.2.1用况图综述 从总体上阐述整个用况图的目的、结构、功能以及组织。以文字描述文档所包含的部分。 A.3.2.2参与者描述 列出一个用况图中的每个参与者的名称，可按字母顺序或其他某种有规律的次序排列。必要时要对参与者附有必要的文字说明，也可以说明它所涉及到的用况和交互图的名称。 A.3.2.3用况描述 对于一个用况图中的每个用况，记录如下的信息。要按某种顺序排列它们。 a 名称 每个用况有一个在图内唯一的名字，并且该名字要反映出它所描述的功能。书写位置是在用况描述的第一行。 b 行为描述 用自然语言分别描述参与者的行为和系统行为，建议把参与者的行为靠左对齐书写，把系统行为靠较右的位置对齐书写。 在描述较复杂的含有循环或条件分支的行为时，可使用一些结构化编程语言的控制语句，如while,for，if-then-else等。 当要表明控制语句的作用范围时，可使用括号，如｛、｝或begin, end等，也可以使用标号，以便更清楚地表示控制走向。 如有必要，可使用顺序图、状态图或协作图描述参与者的行为和系统行为。 c 用况图中元素间的关系描述产生一份描述用况图中的参与者与用况间、用况间以及参与者间关系的文字性描述文档。具体地由下面几部分构成： 1 关系的名称； 2 关系的类型：关联，泛化，包含，扩展； 3 关系所涉及的类目：对关系所连接的类目应指明名称和类型 参与者或用况 。 d 其他与用况图有关的说明与该用况图有关的但上面文档中没有涉及的其他信息的描述。 A.4类图文档 A.4.1图形文档 即所绘制的类图。 A.4.2文字说明 文字描述由以下部分组成：类图综述、类描述、关联描述、泛化描述、依赖描述和其他与类图有关的说明。在实际使用时，这些部分是可选的。 A.4.2.1类图综述 从总体上阐述整个类图的目的、结构、功能及组织。以文字描述文档所包含的部分。 A.4.2.2类描述 类描述包括类整体说明、属性说明、服务说明、关联说明、泛化说明、依赖说明及其他说明。 a 类的整体说明 对整个类及其对象的情况加以说明，内容包括： 1 类名：应是中文名或英文名； 2 解释：对类的责任的文字描述； 3 一般类：描述该类是从那些类泛化而来的； 4 状态转换图：描述该类的实例的状态图的名称列表； 5 主动性：有无主动性； 6 永久性：有无永久性； 7 引用情况：若此类为其他类图所定义，则要标明它所属于的类图；若此类被其他类图引用，则标明所引用的类图； 8 多重性 9 其他：是否有特别的数据完整性或安全性要求等。 b 属性说明 逐个地说明类的属性。每个属性的详细说明包括以下内容： 1 属性名：中文属性名或英文属性名； 2 多重性：该属性的多重性； 3 解释：该属性的作用； 4 数据类型； 5 聚合关系：如果这个属性的作用是为了表明聚合关系，则在这里说明这种关系； 6 组合关系：如果这个属性的作用是为了表明组合关系，则在这里说明这种关系； 7 关联关系：如果这个属性是为了实现该类的对象和其他对象之间的链而设置的，则在这里明确地说明这一点； 8 实现要求：该属性的取值范围、精度、初始值及其他描述。 c 服务说明 逐个地说明类中的每个服务。每个服务的详细说明包括以下内容： 1 服务名：中文服务名或英文服务名； 2 主动性：有无主动性； 3 多态性：有无多态性； 4 解释：该服务的作用； 5 服务的活动图：详细描述活动具体细节的活动图的名称列表； 6 约束条件及其他：若该服务的执行有前置条件、后置条件或执行时间的要求等其他需要说明的事项，则在此说明。 d 关联 描述