详细设计模板

1、项目名称： 项目编号： 第 版文档编号：项目编号_DD_流水号 第 册/共 册详细设计版本：Ver 0.1大连东软软件人才培训中心总页数正文附录生效日期编制：审批：修订记录修订记录日期日期版本版本说明说明作者作者目录1.1.引言引言.11.1术语.21.2缩略语.22.模块概述模块概述.33.3.模块的功能点模块的功能点.34.4.使用的系统资源使用的系统资源.44.1ROM/RAM 使用量.44.2中断的定义和使用.44.3TIMER 资源的使用.44.4OS 资源的使用.44.5使用的其他资源.45.5.限制条件限制条件.46.6.模块详细设计模块详细设计.56.1文件一览.56.2函数一

2、览.56.3函数调用关系.66.4宏定义.66.5消息一览.76.6数据类型定义.76.7全局变量定义.76.8数据表设计.76.9接口函数设计.86.9.1函数 1（实际函数名）.86.9.2函数 2.96.10内部函数设计.96.10.1函数 1（实际函数名）.96.10.2函数 2.96.10.3函数 3.107.7.附件附件.117.1模块技术点整理.117.2参考文档.11详细设计 版本：Ver 0.1 第 1 页东软集团 IT 人才实训中心1.1. 引言引言说明：简短的描述一下文档的用途、范围以及预期读者。注意：本模板用于编写模块级软件设计文档。进行软件设计之前应该已经完成整个系统

3、（对于小型系统而言）或上一级模块（对于大型系统而言）的概要设计。本模版列出了模块详细设计时需要做的比较完全的内容、可以根据项目情况适当进行裁剪。模板格式说明：蓝色斜体字：是模板的说明文字，实际写文档的时候需要去掉。紫色斜体字：是模板的例子，实际写文档的时候需要去掉。图表全部使用引用题注和交叉引用的方式、通过更新域、可以自动排序。详细设计 版本：Ver 0.1 第 2 页东软集团 IT 人才实训中心1.11.1 术语术语说明：列出文档中使用的相关术语。例：表表 1 1- -1 1：技術用語：技術用語1.21.2 缩略语缩略语说明：按字母顺序列出文档中使用的缩略语。例：表表 1 1- -2 2：缩

4、略语：缩略语番号用語説明1UARTUniversal Asynchronous Receiver Transmitter。番号原词缩写説明1MAINGUI ModuleUIMAIN 側 GUI Module详细设计 版本：Ver 0.1 第 3 页东软集团 IT 人才实训中心2. 模块概述模块概述2.12.1 模块结构图模块结构图描述一下该模块的结构，比如包含哪些子模块，并介绍各子模块的功能。3.3. 模块的功能点模块的功能点说明：模块的功能点变更或新规的功能点例：3.1 本模块实现机能点(最好不要和标题编号使用相同的数字，可以按照第二层次标题格式来写)实现送信 Command 画面。Medi

5、a Module 側 Command 応答表示画面作成。Media Module 側 Status 情報表示画面作成。表示的存储。详细设计 版本：Ver 0.1 第 4 页东软集团 IT 人才实训中心4.4. 模块详细设计模块详细设计4.14.1 类一览类一览例：表表 4 4- -1 1：类一览表：类一览表类名描述Class1类功能描述Class2类功能描述Class3类功能描述4.24.2 类设计类设计类图详细设计 版本：Ver 0.1 第 5 页东软集团 IT 人才实训中心4.34.3 宏定义宏定义例：ucPowerStatus (Power 状态变量)使用的宏定义一览表表 4 4- -2

6、 2：ucPowerStatusucPowerStatus 使用宏定义一览表使用宏定义一览表宏名值描述POWER_ON0 x00POWER_OFF0 x01POWER_TRANSFER0 x02ucPowerTable (PowerTable 使用的索引定义)使用的宏定义一览表表 4 4- -3 3：ucPowerTableucPowerTable 使用宏定义一览表使用宏定义一览表宏名值描述POWER_TBL_INIT0 x00POWER_TBL_POWER_ON_PRO0 x01POWER_TBL_POWER_OFF_PRO0 x024.44.4 消息一览消息一览例：表表 4 4- -4 4

7、：xxxxxx 模块消息接口一览表模块消息接口一览表消息定义值源模块目标模块描述4.54.5 数据类型定义数据类型定义说明：自定义的数据类型、主要指结构体。表表 4 4- -5 5：xxxxxx 数据类型一览表数据类型一览表类型名描述详细设计 版本：Ver 0.1 第 6 页东软集团 IT 人才实训中心4.64.6 全局变量定义全局变量定义说明：模块中使用到的全局变量。表表 4 4- -6 6：xxxxxx 模块全局变量一览表模块全局变量一览表变量名类型描述4.74.7 数据表设计数据表设计说明：开发过程中制作的数据表格、Matrix 等、如果 word 方式难于描述、可以些附加文档。4.84

8、.8 接口函数设计接口函数设计说明：详细描述本模块提供的接口的函数。此章节为他模块提供 IF 使用指导信息。4.8.14.8.1 函数函数 1 1（实际函数名实际函数名）说明：关于函数流程、可以画流程图、也可以画 PAD 图、细化到 24 行代码、逻辑简单的函数可以不画流程图、详细设计 版本：Ver 0.1 第 7 页东软集团 IT 人才实训中心4.94.9 内部函数设计内部函数设计4.9.14.9.1 函数函数 1 1（实际函数名实际函数名）表表 4 4- -7 7：TraverseDirTraverseDir函数说明函数说明函数名称void TraverseDir(pstrpath pst

9、rpath)参数参数类型COMMENT参数列表pstrpathpstrpath文件夹的路径返回值无Void功能说明1、 构建一个通配符的字符串CString strWildcard(pstr); strWildcard += _T(*.*);2、 找到文件/ start working for files BOOL bWorking = finder.FindFile(strWildcard);3、 循环查找while (bWorking) bWorking = finder.FindNextFile(); / skip . and . files; otherwise, wed / recu

10、r infinitely! if (finder.IsDots() continue; / if its a directory, recursively search it if (finder.IsDirectory() CString path = finder.GetFilePath(); CString dirName = “-” + GetDirPathName(); fileVec. push_back(dirName); TraverseDir (str); else CString filename = “- ”+ finder.GetFileName(); fileVec.

11、 push_back(filename); 4、 关闭 finderclose(finder);制约和注意事项文件夹名和文件名禁止以“-”开头异常处理无详细设计 版本：Ver 0.1 第 8 页东软集团 IT 人才实训中心表表 4 4- -8 8：WriteFileHierWriteFileHier 函数说明函数说明函数名称Void WriteFile()参数参数类型COMMENT无无返回值无Void功能说明1.判断文件层次结构的容器是否变化2.如果无变化直接返回3.如果有变化将容器值写入文件中，循环遍历每个元素，如果是文件夹则空一个字符写入一行，如果是文件则空两个字符写入制约和注意事项这个函

12、数在程序退出时调用异常处理无函数流程图4.9.24.9.2 函数函数 2 2例： 表表 4 4- -9 9：ReadFileHierReadFileHier 函数说明函数说明函数名称Void ReadFileHier ()参数参数类型COMMENT参数列表无无返回值无Void功能说明1.从文件一行一行循环读入字符串2.如果该行空一个字符，则读出加入一个“-”写入容器3.否则加入“-”写入容器制约和注意事项这个函数在程序初始化时调用异常处理无【函数处理流程】4.9.34.9.3 函数函数 3 3例： 表表 4 4- -1010：xxx_initxxx_init 函数说明函数说明函数名称Void XXXX_Init(USORT input1, SORT input2)参数参数类型COMMENTInput1USORT参数列表Input2USORT返回值无Void功能说明初始化 XXX 模块的