内容发布更新时间 : 2024/12/26 2:06:21星期一 下面是文章的全部内容请认真阅读。
公司或企业图标
XX 详细设计说明书
请输入密级
XX 详细设计说明书
关键词: 摘 要:
缩略语清单:<对本文所用缩略语进行说明,要求提供每个缩略语的英文全名和中文解释。
缩略语 英文全名 中文解释
版权所有,侵权必究
第5页,共11页
1
1.1
简介
目的
描述本文的目的,一般详细设计必须能够直接指导编码活动。
1.2 范围
本节应描述文档所包括和不包括的内容。
2 详细设计
对于在概要设计说明书中给出的软件实体,本节集中描述它们的详细描述部分。
2.1 模块1详细设计
描述模块中定义和使用的数据,包括: 简单数据,如模块级的全局变量、常量、宏; 复合数据,如模块内部的结构、联合...;
2.1.1 数据描述
在2.1.1.1中描述本模块中的简单变量、常量、宏; 从2.1.1.2起描述本模块中的复合数据,如结构、联合等;
1. 简单数据描述;
描述在本模块中定义和使用的简单变量、常量、宏;
按照下列格式进行简单数据的描述 功能描述:描述该数据的用途 数据定义:定义该数据
2. 结构1
定义和说明该数据结构(包括联合);
按照下列格式进行数据结构的描述 数据结构描述:描述该数据结构的用途
数据结构定义:用实际的编程语言定义该数据结构 数据项描述:
公司或企业图标
XX 详细设计说明书
请输入密级
数据类型 3. 结构2
数据项定义 版权所有,侵权必究
数据项描述 第7页,共11页
2.1.2 函数描述
本节应按照下列格式进行描述: 标识:模块名称
类型:模块类型,如,2级设计中的模块,1级设计中的进程
功能概述:简要描述本模块功能,要和概要设计文档中相关模块分解的描述一致。 函数调用关系: 用层次图或结构图的方式描述函数调用关系,如:
Function1A,BCFunction2Function3
Figure 1
1. 函数1
用以下格式描述函数 Function: // 函数名称
Description: // 函数功能、性能等的描述 Calls: // 被本函数调用的函数清单
Data Accessed: // 被访问的全局变量和数据库表 Data Updated: // 被修改的全局变量和数据库表
Input: // 输入参数说明,包括每个参数的作用、取值说明及参数间关系。 Output: // 对输出参数的说明。 Return: // 函数返回值的说明 Others: // 其它说明
----------------------------------------------------------------------------------------------------
Module 1 Structure Chart 模块1结构图
D,E实现: 这里可以使用伪码或流程图 例子:
m2ua_return_t m2ua_nif_sendto_mtp2
/*该函数重用原来MTP3模块中提供的向MTP2发消息的函数*/