文 档 编 密 文 拟 日 码 级 档 版 制 本 人 期 项目编号和项目名称 设计说明书 [其他如副标题/子模块] 郑重声明： XX 软件股份有限公司版权所有。本文档中任何部分未经 XX 软件股份有限公 司书面授权，不得将材料泄露给第三方，不得以任何手段、任何形式进行复制与传播。 变更履历 版本 1.0 日期 变更位置 变更理由/变更内容 创建 变更人 备注 目录 1 概述.................................................................................................................3 2 总体设计........................................................................................ 3 3 模块 1 设计（模块唯一编号）................................................................3 3.1 子模块 1 设计（模块唯一编号）....................................................................3 3.1.1 模块概述..............................................................................................3 3.1.2 类图.....................................................................................................3 3.1.3 调用关系/时序图....................................................................................4 3.1.4 类及接口设计........................................................................................5 3.2 子模块 2 设计（模块唯一编号）....................................................................6 3.2.1 模块概述..............................................................................................6 3.2.2 类图.....................................................................................................6 3.2.3 调用关系/时序图....................................................................................6 3.2.4 类及接口设计........................................................................................6 【重要提示】 本文档的目录结构应与需求规格说明书一一对应。 1 概述 描述该功能的主要设计目标和设计思路，对设计部分的内容做一个简要的说明。 2 总体设计 总体设计针对所有不能归入任何一个模块的功能进行设计，可以分节进行描述： 1. 对于较为复杂的模块，可以使用模块架构图来说明模块的整体框架结构，以 方便阅读者直观地理解模块的体系架构 2. 从总体上描述所有功能模块应遵循的规则。例如模块划分的原则等。 3. 代码的目录结构 4. 性能方面的设计：例如数据缓冲的设计等 5. 安全性方面的设计 6. 扩展性方面的设计 7. 稳定性方面的设计 3 模块 1 设计（模块唯一编号） 3.1 子模块 1 设计（模块唯一编号） 3.1.1 模块概述 对模块 1 的设计进行概要描述，主要有设计思路、主要原理、设计目标等。 3.1.2 类图 描述所有类之间的关联、继承、依赖等关系。可以使用 UML 类图的规则来绘制 （推荐使用 VisualPraradigm 或 Rational Rose 工具进行绘制）。类图中出现的现 有系统中已经实现的类，可以不用体现类中具体的属性和方法，对于本模块设计的类 必须体现类中 public 类型的所有方法及属性（属性的 get 和 set 方法可以省略）。 如果类比较多，可以分多个类图进行绘制。类图以图片的形式插入本文档，同时保留 与本文档同名的类图文件作为附件，以便修改。 例： 3.1.3 调用关系/时序图 注：调用关系/时序的技术原则为实用原则，即对于不言而喻的调用关系/时序图 可以不必描述，例如简单的增、删、改操作，这里只需描述调用关系较为复杂的时序。 3.1.3.1 时序图 1 描述一个完整的业务功能操作的处理流程，通过类之间的调用关系流程来体现程 序的执行顺序。可以使用 UML 时序图的规则来绘制（推荐使用 VisualPramdigm 或 Rational Rose 工具进行绘制）。时序图中对现有系统中已经实现的类的调用，可以 不用体现类中被调用方法的具体参数，对于本模块设计的类的调用，则必须体现类中 所有方法的调用参数及类型。时序图以图片的形式插入本文档，同时保留与本文档同 名的时序图文件作为附件，以便修改。注：需要先描述此时序图发生的场景以便于理 解，例如“点击生成按钮触发此时序图”。 例： 3.1.3.2 时序图 2 同时序 1 3.1.4 类及接口设计 3.1.4.1 基础类 1 基础类的设计，可以使用 UML 类图来描述，或者使用类定义的伪代码来描述， 描述时要注意把类属性的含义、类型、约束、方法、参数等描述清楚，如果涉及到持 久化（存储），需要描述其存储方式（文件、数据库、注册表等等）、数据表、文件、 位置等等。如果涉及到较为复杂的数据库读写，需要将该 SQL 写出来，SQL 中的关 键字以蓝色标识，参数以紫色标识。例如： select * from eai_reportgroup where rgp_pguid=rgpGuid order by rgp_order 3.1.4.2 基础类 2 3.1.4.3 接口 1 3.1.4.4 接口 2 3.2 子模块 2 设计（模块唯一编号） 3.2.1 模块概述 3.2.2 类图 3.2.3 调用关系/时序图 3.2.3.1 时序图 1 3.2.3.2 时序图 2 3.2.3.3 类及接口设计 3.2.3.4 基础类 1 3.2.3.5 基础类 2 3.2.3.6 接口 1 3.2.3.7 接口 2