软件文档写作04-文档类型2剖析.ppt

* (4) 分层风格 分层风格能将代码组织成一些不相交的层。在这种情况下，根据预定的规则，较高层的代码可以使用较低层的代码。 如，可通过规则规定：只能使用相邻较低层代码，可以使用任何较低层代码，或者可以使用较低层或通用层代码。 这种风格能用来说明代码是如何在虚拟机内分解的。一般来说，较低层通常涉及的是系统内靠近硬件的部分，较高层则包含更多依赖应用的软件。 分层风格能应用于培训和重用支持,还能用来支持可移植性。 分层风格一览表： 布局 关系特性 元素特性 关系 元素 若A层位于B层之上，则B层就不能位于A层之上。每一部分软件只能分配给一个层 针对模块视图类型 层的名称。 层包容的软件单元。 允许层使用的软件。这一特性编制文档时分为两个部分：一. 提供层间和层内的使用规则，如“允许层使用任何较低层的软件”和“不允许软件使用同一层中的其它软件”；二. 列出这些规则可容许的其它所有例外情况。 层的内聚：对层所表示的虚拟机的描述。 “允许使用”，它是模块视图类型一般的“依赖关系”的特化。如果P1的正确性依赖于当前P2的正确实现，就可以说P1使用P2 层 分层风格表示法： 1. 非正规表示法 有堆栈、分段层、环形、分段层3维烤箱模型、内容、接口以及大小和颜色等多种。 ① 堆栈，如下图。层的“允许使用”关系由几何邻接表示，从上至下阅读。 A B ② 分段层。下图说明了A可以使用B和C，而B和C依次可以使用D，B和C也可以相互使用。 A D B C 图例(非正规表示法) 层 x y 允许 x 使用 y 分段层实质上使“允许使用”关系成为对元素的部分定序。 如果仅仅从层的角度看，上图完全等同于下图，即BC层是B层和C层内容的并集。 A BC D ③ 环形。最常见的表示法变体是将层表示为一组同心圆或环形。最里层的环形对应于最低层，最外层的环形对应于最高层。环形还可以再分区。如图 A C B2 B3 B1 A C B3 B2 B1 ④ 带边车结构的层。许多被称为“分层”的结构在某种程度上类似于下图： A B C D 分层风格还有一些非正规表示法，可以参考《软件构架编档》P.76。 2. UML表示法。 遗憾的是，UML不具备针对层的内置图元。但是，非分段的层能使用“包”以UML表示，如下图。 A层 B层 allowed to use 包是一种能将元素组织成组的通用机制。图中，为层引入额外的包，方法是将其定义为包构造型，层即可以展示成UML包，且包之间具有“允许使用”的依赖性。 关于这个问题深入的讨论，请参阅《软件构架编档》P.80。 与其它风格的关系 作为一个例子，我们讨论分层风格与其它风格的关系。事实上，其它风格也都存在这一关系问题。 1. 模块分解 层往往被与分解视图中的模块等同。事实上，层可以是模块，也可以不是。要注意的是，模块虽然可以再分解，但层却未必总是可以再分解。引入分段层通常用来展示对模块的映射。如果模块跨越不同的层，则用颜色填充图案。下图展示的是层和分解视图中的模块。 功能驱动模块 共享服务 数据银行家 物理模型 过滤行为 设备接口 应用数据类型 软件实用工具 扩展计算机 图例： 行为隐蔽模块 软件决策隐蔽模块 硬件隐蔽模块 2. 级 层通常会与n级客户机－服务器构架中的级产生混淆，如下图。 表示层 商业逻辑 数据服务器 这是一个“级”图，但很多人往往把它当成“层”图。请留意双向箭头，这是级图的一个重要标志。 在分布式环境中给机器分配资源、元素间的数据流以及通信信道的存在和使用，都倾向于以级图表示，而层图则无法区分它们。 3. 模块“使用”风格 由于层能表达“允许使用”关系，因此它非常符合使用风格。如果系统设计师决定在文档中集中包含一种风格，就很可能还会——虽然不总是会——包含其它风格。当然，“使用”关系不能违反“允许使用”关系。因此，在系统开发过程中，系统设计师应该以广泛的“允许使用”规范指导开发者。这一规范允许有效的建立任何重要的子集，而不必包含无用的程序或信息。然后，即可编制文档实际使用。 4. 子系统 层能使用子系统概念跨越概念路径。下图是一个有层标签的子系统分段层图。 操作系统 网络通信 工作站调度程序 显示生成 监测 记录回放 模拟 防撞 位置显示 子系统层 应用支持层 通信层 平台层 注：在该上下文中，子系统由顶层段和任何它可以使用的较低层的任何段构成。 3.6 组件和连接器(CC)视图类型的风格 组件和连接器(CC)视图类型能为系统执行单元编制文档服务。CC风格是CC视图类型的特化，方法是引入一个特定的组件和连接器类型集，并指