详细设计说明书(面向对象).doc

xx 子系统或模块详细设计说明书 - 1 - XXX 子系统或模块详 细设计说明书 顺丰速运(集团)有限公司 xx 子系统或模块详细设计说明书 - 2 - 版本历史记录 日期日期版本号版本号版本内容版本内容作者作者审核人审核人审核日期审核日期 2006-4-21V1.1 修改参考文献和 子系统或模块概 述，添加了界面 设计 许辽 2006-7-28V1.2改进整体结构许辽 xx 子系统或模块详细设计说明书 - 3 - 目目 录录 1.引言引言.4 1.1编写目的.4 1.2文档范围.4 1.3读者对象.4 1.4参考文献.4 1.5术语与缩写解释.4 2.子系统子系统 N 详细设计详细设计.4 2.1子系统概述.4 2.2子系统依赖关系.4 2.3子系统总体结构.5 2.4模块 N 设计说明.6 2.4.1模块描述.6 2.4.2功能.6 2.4.3*性能.6 2.4.4关键算法.6 2.4.5模块构成.6 Class 关系图.7 Class 构成说明.8 2.4.6主要数据结构.9 2.4.7界面设计.9 2.4.8*尚未解决的问题.9 xx 子系统或模块详细设计说明书 - 4 - 1.1.引言引言 1.11.1 编写目的编写目的 本详细设计说明书是针对XXX系统而编写。目的是对该项目进行详细设计，在概要设计的基础上 进一步明确系统结构，详细地介绍系统的各个模块，为进行后面的实现和测试作准备。 1.21.2 文档范围文档范围 本详细设计说明书是XXX系统各子系统详细接口设计说明及核心流程说明，但不包含具体的代 码实现说明与相关单元测试设计。 1.31.3 读者对象读者对象 本详细设计说明书的预期读者为本项目小组的成员以及对该系统感兴趣，在以后想对系统进行 扩展和维护的人员. 1.41.4 参考文献参考文献 提示：提示：列出本文档的所有参考文献（可以是非正式出版物） 。格式如下： 文件编号文件编号文献名称文献名称作作 者者出版单位出版单位发行日期发行日期 1.51.5 术语与缩写解释术语与缩写解释 缩写、术语缩写、术语解解 释释 SPP精简并行过程，Simplified Parallel Process SD系统设计，System Design 2.2.子系统子系统 N N 详细设计详细设计 2.12.1子系统概述子系统概述 提示：提示：（1）说明子系统 “是什么” ， （2）描述子系统的主要功能。 （3）绘制子界面的布局视图； 说明子界面中所有对象的功能和操作方式。 2.22.2子系统依赖关系子系统依赖关系 提示：提示：参考概要设计说明书，说明子系统的对外依赖关系。 xx 子系统或模块详细设计说明书 - 5 - 2.32.3子系统子系统总体结构总体结构 提示：提示： （1）将子系统分解为若干模块，绘制包引用关系图和逻辑图（组件结构图） 。 （2）说明各模块如何协调工作，从而实现子系统的功能。 （3）详细说明子系统的外部接口。 包引用关系图如下所示： ui：系统界面部分，负责接受用户输入，显示系统输出，负责其他模块功能的协调调用，并含 有站内搜索功能，即在用户指定的已打开的ftp站点中搜索用户需要的资源。ui部分调用 common部分的功能读取xml文件中保存的界面元素属性信息，用户最近访问过的10个ftp信息， 用户选择的下载的ftp内容列表及其他需要通过xml文件保存的信息。 client：实现ftp客户端的功能，ftp连接，ftp上传及下载：上传或下载用户指定的资源，并 返回相应的信息。 search:资源实时检索部分，根据用户输入的资源名称关键字，资源类型和选择的检索方式检 索用户需要的资源，并验证资源的可用性，返回可用资源及其大小，速度等相关信息。 preview：资源预览部分，显示用户选择的资源的部分内容，以使用户决定是否需要该资源。 preview部分调用common部分读取属性文件的内容亦显示预览资源内容的显示格式。 逻辑图（组件结构图）如下所示： UI CLIENT PREVIEW COMMON SEARCH xx 子系统或模块详细设计说明书 - 6 - 2.42.4模块模块 N N 设计说明设计说明 提示：提示： 从本段开始，逐个地给出模块相关程序的设计考虑。以下给出的提纲是针对一般情况的。对于 一个具体的模块，尤其是层次比较低的模块，其很多条目的内容往往与它所隶属的上一层模块的对 应条目的内容相同，在这种情况下，只要简单地说明这一点即可。 .1模块描述模块描述 提示：提示： 给出对该模块的简要描述，主要说明安排设计模块的目的意义，并且，还要说明模块的特点 （如 是常驻内存还是非常驻？有无覆盖要求？是顺序处理还是并发处理等） XXX模块是实现 .2功能功能 提示：提示：说明该程序应具有的功能，如果模块存在 2 个以上的子模块则可以按模块级的结构展开 设计。即：子模块 N、子模块 N 描述、性能、关键算法、子模块构成、界面设计等。 .3* *性能性能 提示：提示：说明对该程序的全部性能、精度、时间特性等要求。该项为可选内容。 .4关键算法关键算法 提示：提示：此处应对关键算法进行描述（包含算法和计算流程） 。 .5模块构成模块构成 提示：提示：用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说 明参数赋值和调用方式，说明与本程序相直接关联的数据结构（数据库、数据文卷） 。采用 UML 的设计图：包图、类图、时序图（或协作图） 、*活动图、*状态图。标记*的为可选项。 xx 子系统或模块详细设计说明书 - 7 - Class 关系图关系图 以下为示例。 xx 子系统或模块详细设计说明书 - 8 - Class 构成说明构成说明 提示：对类关系图中涉及到的类进行详细说明，包含内部变量，属性，构造以及操作的说明。提示：对类关系图中涉及到的类进行详细说明，包含内部变量，属性，构造以及操作的说明。 此处可以采用此处可以采用 JavaDoc 附件的方式代替以下附件的方式代替以下 Class 构成说明构成说明。 CBtrapi 是控制 Btrieve 文件 I/O 的类。画面中的数据操作是用 CbtrApi 类做成 Btribeve 文件。 类的层次和相关类类的层次和相关类 CbtrApi 文件 I/O 类 类成员类成员 内部变量内部变量 m_sPosBlock BTRCALL 函数的位置块 *pCFileInfo 指定 Btrieve 文件信息类的指针 属性（属性（protectedprotected） 构造构造 CBtrApi *pCFileInfo 的初始化 数据转换（数据转换（protectedprotected） CharToStr 记录从 Hex 转换成 CSring StrTochar 记录从 CSring 转换成 Hex 操作（操作（publicpublic） GetFirst 用 Btrieve 文件取得第一个记录 GetNext 用 Btrieve 文件取得当前记录后面的记录 Open 打开指定的 Btrieve 文件 Insert 用 Btrieve 文件插入新的记录 Updata 更新指定的记录 Delete 删除指定的记录 Close 关闭 Btrieve 文件 操作详细说明操作详细说明 函数名：com_ora_UpdateCaseCode (1)功能说明： 修改案件编号。 (2)函数头部： Public Function com_ora_UpdateCaseCode( ByVal P_OLDCODE As String, ByVal P_NEWCODE As String ) As Long (3)参数及返回值： 参数名类型I/O说明 xx 子系统或模块详细设计说明书 - 9 - P_OLDCODEStringI旧的案件编号 P_NEWCODEStringI新的案件编号 返回值Long 0: 成功 -1: 失败 1010: 旧案件编号长度不是 10 位 1020: 新案件编号长度不是 10 位 1030: 存在于受理举报立案中 1040: 存在于转办举报立案中 1050: 存在于重复举报立案中 1060: 未查找到旧案件编号 (4)参照数据库表： 表 EXPOSURECASEINDEX 表 REPEATEXPOSURECASE (5)调用子函数：无 (6)补充说明：如果需要添加算法的特殊说明，请添加流程图或伪代码 .6主要数据结构主要数据结构 提示：提示： a存取的数据库表和字段； b调用它的类、方法或函数； c调用的其它程序