详细设计模板.docx
《详细设计模板.docx》由会员分享，可在线阅读，更多相关《详细设计模板.docx（10页珍藏版）》请在冰点文库上搜索。
详细设计模板
项目名称：
项目编号：
第版
文档编号：
项目编号_DD_流水号第册/共册
详细设计
版本：
Ver0.1
大连东软软件人才培训中心
总页数
正文
附录
生效日期
编制：
审批：
修订记录
日期
版本
说明
作者
1.引言
说明：
简短的描述一下文档的用途、范围以及预期读者。
注意：
本模板用于编写模块级软件设计文档。
进行软件设计之前应该已经完成整个系统（对于小型系统而言）或上一级模块（对于大型系统而言）的概要设计。
本模版列出了模块详细设计时需要做的比较完全的内容、可以根据项目情况适当进行裁剪。
模板格式说明：
蓝色斜体字：
是模板的说明文字，实际写文档的时候需要去掉。
紫色斜体字：
是模板的例子，实际写文档的时候需要去掉。
图表全部使用引用题注和交叉引用的方式、通过更新域、可以自动排序。
1.1术语
说明：
列出文档中使用的相关术语。
例：
表11：
技術用語
番号
用語
説明
1
UART
UniversalAsynchronousReceiverTransmitter。
1.2缩略语
说明：
按字母顺序列出文档中使用的缩略语。
例：
表12：
缩略语
番号
原词
缩写
説明
1
MAINGUIModule
UI
MAIN側GUIModule
2.模块概述
2.1模块结构图
描述一下该模块的结构，比如包含哪些子模块，并介绍各子模块的功能。
3.模块的功能点
说明：
模块的功能点
变更或新规的功能点
例：
3.1本模块实现机能点（最好不要和标题编号使用相同的数字，可以按照第二层次标题格式来写）
■实现送信Command画面。
■MediaModule側のCommand応答データを表示する画面の作成。
■MediaModule側のStatus情報を表示する画面作成。
■表示データ的存储。
4.模块详细设计
4.1类一览
例：
表81：
类一览表
类名
描述
Class1
类功能描述
Class2
类功能描述
Class3
类功能描述
4.2类设计
类图
4.3宏定义
例：
ucPowerStatus（Power状态变量）使用的宏定义一览
表84：
ucPowerStatus使用宏定义一览表
宏名
值
描述
POWER_ON
0x00
POWER_OFF
0x01
POWER_TRANSFER
0x02
ucPowerTable（PowerTable使用的索引定义）使用的宏定义一览
表85：
ucPowerTable使用宏定义一览表
宏名
值
描述
POWER_TBL_INIT
0x00
POWER_TBL_POWER_ON_PRO
0x01
POWER_TBL_POWER_OFF_PRO
0x02
4.4消息一览
例：
表86：
xxx模块消息接口一览表
消息定义
值
源模块
目标模块
描述
4.5数据类型定义
说明：
自定义的数据类型、主要指结构体。
表87：
xxx数据类型一览表
类型名
描述
4.6全局变量定义
说明：
模块中使用到的全局变量。
表88：
xxx模块全局变量一览表
变量名
类型
描述
4.7数据表设计
说明：
开发过程中制作的数据表格、Matrix等、如果word方式难于描述、可以些附加文档。
4.8接口函数设计
说明：
详细描述本模块提供的接口的函数。
此章节为他模块提供IF使用指导信息。
4.8.1函数1（实际函数名）
说明：
关于函数流程、可以画流程图、也可以画PAD图、细化到2～4行代码、逻辑简单的函数可以不画流程图、
4.9内部函数设计
4.9.1函数1（实际函数名）
表810：
TraverseDir函数说明
函数名称
voidTraverseDir（pstrpathpstrpath）
参数
参数类型
COMMENT
参数列表
pstrpath
pstrpath
文件夹的路径
返回值
无
Void
功能说明
1、构建一个通配符的字符串
CStringstrWildcard（pstr）;
strWildcard+=_T（"\\*.*"）;
2、找到文件
//startworkingforfiles
BOOLbWorking=finder.FindFile（strWildcard）;
3、循环查找
while（bWorking）
{
bWorking=finder.FindNextFile（）;
//skip.and..files;otherwise,we'd
//recurinfinitely!
if（finder.IsDots（））
continue;
//ifit'sadirectory,recursivelysearchit
if（finder.IsDirectory（））
{
CStringpath=finder.GetFilePath（）;
CStringdirName=“-”+GetDirPathName（）;
fileVec.push_back（dirName）;
TraverseDir（str）;
}else
{
CStringfilename=“--”+finder.GetFileName（）;
fileVec.push_back（filename）;
}
}
4、关闭finder
close（finder）;
制约和注意事项
文件夹名和文件名禁止以“-”开头
异常处理
无
表811：
WriteFileHier函数说明
函数名称
VoidWriteFile（）
参数
参数类型
COMMENT
无
无
返回值
无
Void
功能说明
1.判断文件层次结构的容器是否变化
2.如果无变化直接返回
3.如果有变化将容器值写入文件中，循环遍历每个元素，如果是文件夹则空一个字符写入一行，如果是文件则空两个字符写入
制约和注意事项
这个函数在程序退出时调用
异常处理
无
函数流程图
4.9.2函数2
例：
表812：
ReadFileHier函数说明
函数名称
VoidReadFileHier（）
参数
参数类型
COMMENT
参数列表
无
无
返回值
无
Void
功能说明
1.从文件一行一行循环读入字符串
2.如果该行空一个字符，则读出加入一个“-”写入容器
3.否则加入“--”写入容器
制约和注意事项
这个函数在程序初始化时调用
异常处理
无
【函数处理流程】
4.9.3函数3
例：
表813：
xxx_init函数说明
函数名称
VoidXXXX_Init（USORTinput1,SORTinput2）
参数
参数类型
COMMENT
参数列表
Input1
USORT
Input2
USORT
返回值
无
Void
功能说明
初始化XXX模块的变量
制约和注意事项
无
异常处理
无
【函数处理流程】
5.附件
5.1模块技术点整理
说明：
技术点识别
应用的设计模式
应用的算法与数据结构
使用的库函数或共通函数
5.2参考文档
编号
文档名称
版本
作者
升级会员 