软件详细设计说明书(2).docVIP

软件详细设计说明书(2)

第PAGE8页共NUMPAGES10页

xxx项目详细设计说明书

（xxx模块）

拟制

日期

yyyy-mm-dd

评审人

日期

批准

日期

签发

日期

软件详细设计说明书(2)全文共1页，当前为第1页。

软件详细设计说明书(2)全文共1页，当前为第1页。

文档修订记录

版本

完成人

修改内容

审核

批准

时间

V0.00

创建文档

软件详细设计说明书(2)全文共2页，当前为第2页。

目录

软件详细设计说明书(2)全文共2页，当前为第2页。

TOC\o1-3\u1.简介 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

软件详细设计说明书(2)全文共3页，当前为第3页。

表目录TOC\t表号去除自动编号,1,表号,1,tabledescription,1

软件详细设计说明书(2)全文共3页，当前为第3页。

表1. 关键词 4

表2. 类XXX的属性 5

表3. 方法描述xxx-function 6

图目录TOC\t图号去除自动编号,1,图号,1,figuredescription,1

图1 类图xxx-class 5

图2 流程图xxx-function 6

软件详细设计说明书(2)全文共4页，当前为第4页。

简介

软件详细设计说明书(2)全文共4页，当前为第4页。

编写目的

这部分要描述文档的目的，并指明文档的读者。

适用范围

软件名称

软件功能

解释软件产品将完成或不完成的功能

软件应用

描述软件的应用领域

定义及关键词

关键词

关键词

英文全名

中文解释

参考资料

软件详细设计说明书(2)全文共5页，当前为第5页。

子模块1设计描述

软件详细设计说明书(2)全文共5页，当前为第5页。

类xxx的设计

简介

如果在概要设计中未说明，则在此详细描述类的职责和功能，可使用顺序图、协作图、状态图来详细描述。必要时，可描述本类与相关类之间的静态动态关系。

类图

类图xxx-class

状态设计（可选）

可以用状态图来描述类的状态信息。

属性

可先定义相关的数据结构，再对属性进行描述。

也可以不使用表格、而使用伪代码格式。

类XXX的属性

可见性

属性名称

类型

说明（对属性的简短描述）

Private

Public

Protected

方法

方法xxx

方法描述

Java的函数头注释采用JavaDoc自动生成的格式：

/**

*@functions增删改查XXX

*@paramStringname名字

*@returntrue如果不为空则返回真，false如果为空返回假

*@throws无

*/

软件详细设计说明书(2)全文共6页，当前为第6页。C++使用以下格式：

软件详细设计说明书(2)全文共6页，当前为第6页。

方法描述xxx-function

函数原型

方法的声明，包含可见性

功能描述

描述本方法的功能

被调函数

被本函数调用的函数清单（非系统函数）

主调函数

调用本函数的函数清单（非系统函数）,可选

输入参数

描述每个输入参数的含义、内存管理原则（谁分配、谁释放）

输出参数

描述每个输出参数的含义、内存管理原则（谁分配、谁释放）

返回值

描述返回值的含义

抛出异常

描述可能抛出的异常

实现描述

（使用伪代码、流程图等来描述本方法的详细实现。这部分是详细设计的重点。可以在开发工具中编写后再将文件嵌入到文档中。伪代码请直接写成注释格式，减少编码阶段的注释工作量）

流程图xxx-function

voidTestTask::iMapTaskCmdRecv(CmdMSG*CmdMsg)

{

_UScommand=CmdMsg-CmdCode;

软件详细设计说明书(2)全文共7页，当前为第7页。//生成应答数据帧空间

软件详细设计说明书(2)全文共7页，当前为第7页。

软件详细设计说明书(2)全文共7页，当前为第8页。//获得任务的ID

软件详细设计说明书(2)全文共7页，当前为第8页