《IT工程师职业基础》第五章 大学生职业生涯规划课程lecture-7技术文档写作.ppt

模块视图及文档风格 系统的模块文档将枚举系统的主要实现单元或模块，以及这些单元之间的关系。这样的描述称为模块视图。 我们会发现，这些视图除了描述单元或模块的实现外，还有以下这些用途：培训、涉众之间的交流，以及用作分析的基础。 目前，系统软件分解成可管理单元的方式仍然是重要的系统结构形式之一。至少，这样的分解能够确定系统是如何划分成可分离的部分的，每一部分能对其它部分提供什么样的服务，以及这些部分是如何集聚成更大的集合体的。模块化的选择使得系统具有支持可修改性、可移植性和重用的能力。 当我们希望编制一个完整的软件文档时，应该至少采用一个模块视图类型视图。因此，给出一个建议：为软件文档制定计划时，至少应包含一个模块视图类型的视图。 模块视图类型的文档风格 模块视图类型的文档风格有4种： - 分解风格 - 使用风格 - 泛化风格 - 分层风格 每一种风格都能对基本模块视图类型进行限制。也许，还会添加某些元素和关系类型的专有形式。 (1) 分解风格 表示将代码分解成系统、子系统，子系统还可以再分解为更小的的子系统，等等。 这种风格表示一种自顶向下的系统视图。 几乎所有的系统开始都是采用模块分解风格的。系统设计师通常都会采用分而治之的技术策略来解决问题，以这种风格表现的视图能对他们的活动进行记录。 这种风格对于培训和管理层的交流特别有用，它能为涉众提供系统及其组成的总体视图。 这种风格能帮助开发团队的新成员了解系统的整体情况，以及自己在代码开发方面的角色，它通常是工作任务和完成措施的基础。 这种风格将对可修改性进行处理，通过向系统结构中特定的位置分配功能，即可将可修改性嵌入系统。 * 模块分解风格一览表： 元素 模块，由模块视图类型定义。有时将聚集成其它模块的模块称为子模块 关系 分解关系，是“部分关系”的细化形式。文档义务包括规定用来定义分解的标准 元素特性 由模块视图类型定义 关系特性 可见性，模块被其父模块之外的模块了解的程度及其功能对于这些模块的可用程度 布局 - 分解图中不允许出现循环 - 在一个视图中，一个模块不能同时属于多个模块 分解风格的表示法： 分解表示法主要有两种，即非正规表示法和UML。 1. 非正规表示法。采用具有名称的方框或缩进法表示包容。 2. UML表示如图所示： (a) 表示嵌套，聚集模块以包的形式出现； (b) 表示父模块和子模块之间的一种聚集组合形式，具有明确的所有权含义。 (2) 使用风格 取决于使用关系，是依赖关系的特殊形式。 如软件单元P1的正确性取决于另一单元P2是否正确，那么就可以说P1将使用P2。 这一风格能向开发者说明，必须存在哪些其它模块，他负责的那部分系统才能正确执行。这种风格支持系统的增量开发和部署，因为它允许识别可提前实现的有用系统子集。 模块使用风格一览表： 元素 由模块视图类型定义的模块 关系 使用关系，是“依赖关系”的精化形式。如果模块A依赖于功能正常的模块B的存在来满足自己的需求，那么，模块A就是在使用模块B 元素特性 由模块视图类型定义 关系特性 使用关系可具有一种描述特性，这种特性更详细的描述一个模块会以哪种方式使用另一模块 布局 使用风格不存在布局限制。但是，如果这种关系中的循环包含许多元素，那么，以增量子集产生构架的能力将被削弱 使用风格适用于计划增量开发、系统扩展和子集、调试和测试，以及评估特定更改的效果。 使用风格表示法： 1. 非正规表示法。可以通过非正规形式将使用关系编为一个矩阵，该矩阵的行列均由模块组成。其中元素(x,y)中的标点表示模块x使用了模块y。具体的，可以将分解层次中粒度最细的模块列入矩阵，这样可以通过细粒度的信息来产生增量子集。 2. UML能轻易的表示使用风格。如图： (a) 用户接口模块是一个对数据库模块存在使用依赖性的聚集模块。 (b) 是(a)的变体。用户接口被分解成ABC，其中至少一个模块依赖数据库模块。 (c) 数据库模块有2个接口，分别由用户接口模块和管理系统模块使用。 (3) 泛化风格 说明不同代码单元是如何相互联系的。如，在类层次中，通过查看泛化风格，可以确定哪些类继承自其它类。 这一风格通常用于表示面向对象的设计，以及组成各种形式的维护工作。 对这种风格的模块进行定义的方式能使其捕捉共性和差异性。因为，泛化意味着同时继承接口和实现方案，强调的是接口的共享和重用。 泛化风格一览表： 元素 由模块视图类型定义的模块 关系 泛化，即模块视图类型中的“特化关系” 元素特性 除了模块视图类型中为模块定义的特性外，模块还能拥有“抽象”特性，抽象特