软件具体设计说明书.pdfVIP

软件具体设计说明书

xxx项目具体设计说明书

（xxx模块）

拟制日期yyyy-mm-dd评审人日期

批准日期

签发日期

文档修订记录

名目

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)

1

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.关键词(5)

表2.类XXX的属性(6)

表3.方法描述xxx-function(7)

图名目

图1类图xxx-class(6)

图2流程图xxx-function(7)

1.简介

1.1.编写目的

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

1.2.适用范围

1.2.1.软件名称

1.2.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的属性

3

2.1.5.方法

1.方法xxx

1)方法描述

Java的函数头解释接受JavaDoc自动生成的格式：

/**

*@functions增删改查XXX

*@paramStringname名字

*@returntrue假如不为空则前往真，false假如为空前往假

*@throws无

*/

C++使用以下格式：

表3.方法描述xxx-function

2)实现描述

（使用伪代码、流程图等来描述本方法的具体实现。这部分是具

体设计的重点。可以在开发工具中编写后再将文件嵌入到文档中。伪

代码请直接写成解释格式，削减编码阶段的解释工作量）

图2流程图xxx-function

voidTestTask::iMapTaskCmdRecv(CmdMSG*CmdMsg)

{

4

_UScommand=CmdMsg-CmdCode;

//生成应答数据帧空间

//获得任务的ID

Switch(command)

{

case0x01:

//填写对应的业务字段和数据

break;

case