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

xx子系统或模块详细设计说明书

XXX子系统或模块详细设计说明书

顺丰速运(集团)有限公司

版本历史记录
日期
版本号
版本内容
作者
审核人
审核日期
2006-4-21
V1.1
修改参考文献和子系统或模块概述，添加了界面设计
许辽

2006-7-28
V1.2
改进整体结构
许辽

目 录

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
2.4.5.1 Class 关系图 7
2.4.5.2 Class构成说明 8
2.4.6 主要数据结构 9
2.4.7 界面设计 9
2.4.8 *尚未解决的问题 9

- 9 -

1. 引言
1.1 编写目的
{
本详细设计说明书是针对XXX系统而编写。目的是对该项目进行详细设计，在概要设计的基础上进一步明确系统结构，详细地介绍系统的各个模块，为进行后面的实现和测试作准备。
}
1.2 文档范围
{
本详细设计说明书是XXX系统各子系统详细接口设计说明及核心流程说明，但不包含具体的代码实现说明与相关单元测试设计。
}
1.3 读者对象
{
本详细设计说明书的预期读者为本项目小组的成员以及对该系统感兴趣，在以后想对系统进行扩展和维护的人员.
}
1.4 参考文献
提示：列出本文档的所有参考文献（可以是非正式出版物）。格式如下：
文件编号
文献名称
作 者
出版单位
发行日期

1.5 术语与缩写解释
缩写、术语
解 释
SPP
精简并行过程，Simplified Parallel Process
SD
系统设计，System Design

2. 子系统N详细设计
2.1 子系统概述
提示：（1）说明子系统 “是什么”，（2）描述子系统的主要功能。（3）绘制子界面的布局视图；说明子界面中所有对象的功能和操作方式。

2.2 子系统依赖关系
提示：参考概要设计说明书，说明子系统的对外依赖关系。

2.3 子系统总体结构
提示：
（1）将子系统分解为若干模块，绘制包引用关系图和逻辑图（组件结构图）。
（2）说明各模块如何协调工作，从而实现子系统的功能。
（3）详细说明子系统的外部接口。

包引用关系图如下所示：

SEARCH

COMMON

PREVIEW

CLIENT

UI

n ui：系统界面部分，负责接受用户输入，显示系统输出，负责其他模块功能的协调调用，并含有站内搜索功能，即在用户指定的已打开的ftp站点中搜索用户需要的资源。ui部分调用common部分的功能读取xml文件中保存的界面元素属性信息，用户最近访问过的10个ftp信息，用户选择的下载的ftp内容列表及其他需要通过xml文件保存的信息。
n client：实现ftp客户端的功能，ftp连接，ftp上传及下载：上传或下载用户指定的资源，并返回相应的信息。
n search:资源实时检索部分，根据用户输入的资源名称关键字，资源类型和选择的检索方式检索用户需要的资源，并验证资源的可用性，返回可用资源及其大小，速度等相关信息。
n preview：资源预览部分，显示用户选择的资源的部分内容，以使用户决定是否需要该资源。preview部分调用common部分读取属性文件的内容亦显示预览资源内容的显示格式。

逻辑图（组件结构图）如下所示：

2.4 模块N设计说明
提示：
从本段开始，逐个地给出模块相关程序的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块，尤其是层次比较低的模块，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。

2.4.1 模块描述
提示：
给出对该模块的简要描述，主要说明安排设计模块的目的意义，并且，还要说明模块的特点（如 是常驻内存还是非常驻？有无覆盖要求？是顺序处理还是并发处理等）
{
XXX模块是实现……
}
2.4.2 功能
提示：说明该程序应具有的功能，如果模块存在2个以上的子模块则可以按模块级的结构展开设计。即：子模块N、子模块N描述、性能、关键算法、子模块构成、界面设计等。

2.4.3 *性能
提示：说明对该程序的全部性能、精度、时间特性等要求。该项为可选内容。

2.4.4 关键算法
提示：此处应对关键算法进行描述（包含算法和计算流程）。

2.4.5 模块构成
提示：用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数赋值和调用方式，说明与本程序相直接关联的数据结构（数据库、数据文卷）。采用UML的设计图：包图、类图、时序图（或协作图）、*活动图、*状态图。标记*的为可选项。

2.4.5.1 Class 关系图
以下为示例。

2.4.5.2 Class构成说明
提示：对类关系图中涉及到的类进行详细说明，包含内部变量，属性，构造以及操作的说明。此处可以采用JavaDoc附件的方式代替以下Class构成说明。

{
CBtrapi

是控制Btrieve文件I/O的类。画面中的数据操作是用CbtrApi类做成Btribeve文件。

类的层次和相关类
CbtrApi 文件I/O类

类成员
n 内部变量
m_sPosBlock BTRCALL函数的位置块
*pCFileInfo 指定Btrieve文件信息类的指针

n 属性（protected）

n 构造
CBtrApi *pCFileInfo的初始化

n 数据转换（protected）
CharToStr 记录从Hex转换成CSring
StrTochar 记录从CSring转换成Hex

n 操作（public）
GetFirst 用Btrieve文件取得第一个记录
GetNext 用Btrieve文件取得当前记录后面的记录
Open 打开指定的Btrieve文件
Insert 用Btrieve文件插入新的记录
Updata 更新指定的记录
Delete 删除指定的记录
Close 关闭Btrieve文件

n 操作详细说明

Ø 函数名：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
说明
P_OLDCODE
String
I
旧的案件编号
P_NEWCODE
String
I
新的案件编号
返回值
Long

0: 成功
-1: 失败
1010: 旧案件编号长度不是 10 位
1020: 新案件编号长度不是 10 位
1030: 存在于受理举报立案中
1040: 存在于转办举报立案中
1050: 存在于重复举报立案中
1060: 未查找到旧案件编号

(4) 参照数据库表：
表EXPOSURECASEINDEX
表REPEATEXPOSURECASE

(5) 调用子函数：无

(6) 补充说明：如果需要添加算法的特殊说明，请添加流程图或伪代码

}
2.4.6 主要数据结构
提示：
a．存取的数据库表和字段；
b．调用它的类、方法或函数；
c．调用的其它程序。

2.4.7 界面设计
提示：
a．绘制模块界面的布局视图，说明界面中所有对象的功能和操作方式（可制作有关用户界面图集的附录参考）；
b．用户界面与模块关系表。
界面编号
界面名称
相关模块名称
隶属的子系统

2.4.8 *尚未解决的问题
提示：说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。该项为可选内容。