软件详细设计项目说明指导书.doc

xxx项目具体设计说明书
（xxx模块）

拟制

日期
yyyy-mm-dd
评审人

日期

同意

日期

签发

日期

文档修订统计

版本
完成人
修改内容
审核
同意
时间
V0.00

创建文档

目 录
1. 介绍 5
1.1. 编写目标 5
1.2. 适用范围 5
1.2.1. 软件名称 5
1.2.2. 软件功效 5
1.2.3. 软件应用 5
1.3. 定义及关键词 5
1.4. 参考资料 5
2. 子模块1设计描述 6
2.1. 类xxx设计 6
2.1.1. 介绍 6
2.1.2. 类图 6
2.1.3. 状态设计（可选） 6
2.1.4. 属性 6
2.1.5. 方法 6
3. 数据库具体设计（可选） 9
3.1. 存放过程#/触发器#名称 9
4. 错误处理 10
4.1. 系统错误 10
4.2. 接口错误 10
4.3. 协议错误 10

表目录
表1. 关键词 4
表2. 类XXX属性 5
表3. 方法描述xxx-function 6
图目录
图1 类图xxx-class 5
图2 步骤图xxx-function 6

1. 介绍
1.1. 编写目标
这部分要描述文档目标，并指明文档读者。
1.2. 适用范围
1.2.1. 软件名称

1.2.2. 软件功效
解释软件产品将完成或不完成功效
1.2.3. 软件应用
描述软件应用领域
1.3. 定义及关键词
表1. 关键词
关键词
英文全名
汉字解释

1.4. 参考资料
[1]

2. 子模块1设计描述
2.1. 类xxx设计
2.1.1. 介绍
假如在概要设计中未说明，则在此具体描述类职责和功效，可使用次序图、协作图、状态图来具体描述。必需时，可描述本类和相关类之间静态动态关系。
2.1.2. 类图

图1 类图xxx-class
2.1.3. 状态设计（可选）
能够用状态图来描述类状态信息。

2.1.4. 属性
可先定义相关数据结构，再对属性进行描述。
也能够不使用表格、而使用伪代码格式。
表2. 类XXX属性
可见性
属性名称
类型
说明（对属性简短描述）
Private

Public

Protected

2.1.5. 方法
1. 方法xxx
1) 方法描述
Java函数头注释采取JavaDoc自动生成格式：
/**
* @functions 增删改查XXX
* @param String name 名字
* @return true 假如不为空则返回真，false 假如为空返回假
* @throws 无
*/
C++使用以下格式：
表3. 方法描述xxx-function
函数原型
方法申明，包含可见性
功效描述
描述本方法功效
被调函数
被本函数调用函数清单（非系统函数）
主调函数
调用本函数函数清单（非系统函数）, 可选
输入参数
描述每个输入参数含义、内存管理标准（谁分配、谁释放）
输出参数
描述每个输出参数含义、内存管理标准（谁分配、谁释放）
返回值
描述返回值含义
抛出异常
描述可能抛出异常
2) 实现描述
（使用伪代码、步骤图等来描述本方法具体实现。这部分是具体设计关键。能够在开发工具中编写后再将文件嵌入到文档中。伪代码请直接写成注释格式，降低编码阶段注释工作量）

图2 步骤图xxx-function
void TestTask::iMapTaskCmdRecv (CmdMSG *CmdMsg)
{
_US command = CmdMsg->CmdCode;

//生成应答数据帧空间

//取得任务ID

Switch (command)
{
case 0x01:
//填写对应业务字段和数据
break;

case 0x02:
//填写对应业务字段和数据
break;

default:
break;
}

//发送应答数据帧

//设置任务状态为TASK_STATE_WAITNEXT
}
2. 方法xxx
1) 方法描述

3. 数据库具体设计（可选）
描述存放过程、触发器等具体实现。
3.1. 存放过程#/触发器#名称
1. 描述
原型
原型描述
功效描述
描述实现功效
使用数据库对象
说明使用到相关数据库对象（表、其它存放过程、视图等）
输入参数
描述每个输入参数含义
输出参数
描述每个输出参数含义
返回值
描述返回值含义
2. 实现描述
使用伪代码来描述具体实现。

4. 错误处理
4.1. 系统错误
比如：内存分配失败、任务创建失败等错误是怎样被处理

4.2. 接口错误
描述将要产生并给外部实体用错误码

4.3. 协议错误
描述在协议中没有描述情况怎样处理。（可选）