公司企业6-设计开发管理 03-设计说明书.doc

《公司企业6-设计开发管理 03-设计说明书.doc》由会员分享，可在线阅读，更多相关《公司企业6-设计开发管理 03-设计说明书.doc（7页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、文档编码密级文档版本拟制人日期项目编号和项目名称设计说明书其他如副标题/子模块郑重声明：XX软件股份有限公司版权所有。本文档中任何部分未经XX软件股份有限公司书面授权，不得将材料泄露给第三方，不得以任何手段、任何形式进行复制与传播。 变更履历版本日期变更位置变更理由/变更内容变更人备注1.0创建目 录1概述32总体设计33模块1设计（模块唯一编号）33.1子模块1设计（模块唯一编号）33.1.1模块概述33.1.2类图33.1.3调用关系/时序图43.1.4类及接口设计53.2子模块2设计（模块唯一编号）63.2.1模块概述63.2.2类图63.2.3调用关系/时序图63.2.4类及接口设计6

2、【重要提示】本文档的目录结构应与需求规格说明书一一对应。1 概述描述该功能的主要设计目标和设计思路，对设计部分的内容做一个简要的说明。2 总体设计总体设计针对所有不能归入任何一个模块的功能进行设计，可以分节进行描述：1. 对于较为复杂的模块，可以使用模块架构图来说明模块的整体框架结构，以方便阅读者直观地理解模块的体系架构2. 从总体上描述所有功能模块应遵循的规则。例如模块划分的原则等。3. 代码的目录结构4. 性能方面的设计：例如数据缓冲的设计等5. 安全性方面的设计6. 扩展性方面的设计7. 稳定性方面的设计3 模块1设计（模块唯一编号）3.1 子模块1设计（模块唯一编号）3.1.1 模块概

3、述对模块1的设计进行概要描述，主要有设计思路、主要原理、设计目标等。3.1.2 类图描述所有类之间的关联、继承、依赖等关系。可以使用UML类图的规则来绘制（推荐使用VisualPraradigm或Rational Rose工具进行绘制）。类图中出现的现有系统中已经实现的类，可以不用体现类中具体的属性和方法，对于本模块设计的类必须体现类中public类型的所有方法及属性（属性的get和set方法可以省略）。如果类比较多，可以分多个类图进行绘制。类图以图片的形式插入本文档，同时保留与本文档同名的类图文件作为附件，以便修改。例：3.1.3 调用关系/时序图注：调用关系/时序的技术原则为实用原则，即对

4、于不言而喻的调用关系/时序图可以不必描述，例如简单的增、删、改操作，这里只需描述调用关系较为复杂的时序。3.1.3.1 时序图1描述一个完整的业务功能操作的处理流程，通过类之间的调用关系流程来体现程序的执行顺序。可以使用UML时序图的规则来绘制（推荐使用VisualPramdigm或Rational Rose工具进行绘制）。时序图中对现有系统中已经实现的类的调用，可以不用体现类中被调用方法的具体参数，对于本模块设计的类的调用，则必须体现类中所有方法的调用参数及类型。时序图以图片的形式插入本文档，同时保留与本文档同名的时序图文件作为附件，以便修改。注：需要先描述此时序图发生的场景以便于理解，例如

5、“点击生成按钮触发此时序图”。例：3.1.3.2 时序图2同时序13.1.4 类及接口设计3.1.4.1 基础类1基础类的设计，可以使用UML类图来描述，或者使用类定义的伪代码来描述，描述时要注意把类属性的含义、类型、约束、方法、参数等描述清楚，如果涉及到持久化（存储），需要描述其存储方式（文件、数据库、注册表等等）、数据表、文件、位置等等。如果涉及到较为复杂的数据库读写，需要将该SQL写出来，SQL中的关键字以蓝色标识，参数以紫色标识。例如：select * from eai_reportgroupwhere rgp_pguid=rgpGuidorder by rgp_order3.1.4.2 基础类23.1.4.3 接口13.1.4.4 接口23.2 子模块2设计（模块唯一编号）3.2.1 模块概述3.2.2 类图3.2.3 调用关系/时序图3.2.3.1 时序图13.2.3.2 时序图23.2.3.3 类及接口设计3.2.3.4 基础类13.2.3.5 基础类23.2.3.6 接口13.2.3.7 接口2