2022年软件详细设计说明书 .pdf

xxx项目详细设计说明书（xxx模块）拟制日期yyyy-mm-dd 评审人日期批准日期签发日期名师资料总结-精品资料欢迎下载-名师精心整理-第 1 页，共 10 页 -详细设计说明书第 2 页 共 10 页文档修订记录版本完成人修改内容审核批准时间V0.00 创建文档名师资料总结-精品资料欢迎下载-名师精心整理-第 2 页，共 10 页 -详细设计说明书第 3 页 共 10 页目录1.简介51.1.编写目的 .51.2.适用范围 .51.2.1.软件名称.51.2.2.软件功能.51.2.3.软件应用.51.3.定义及关键词.51.4.参考资料 .52.子模块 1 设计描述.62.1.类 xxx 的设计.62.1.1.简介.62.1.2.类图.62.1.3.状态设计（可选）.62.1.4.属性.62.1.5.方法.63.数据库详细设计（可选）.93.1.存储过程#/触发器#的名称 .94.错误处理.104.1.系统错误 .104.2.接口错误 .104.3.协议错误 .10名师资料总结-精品资料欢迎下载-名师精心整理-第 3 页，共 10 页 -详细设计说明书第 4 页 共 10 页表目录表 1.关键词 .5表 2.类 XXX 的属性.6表 3.方法描述xxx-function.7图目录图 1类图 xxx-class.6图 2流程图 xxx-function.7名师资料总结-精品资料欢迎下载-名师精心整理-第 4 页，共 10 页 -详细设计说明书第 5 页 共 10 页1.简介1.1.编写目的这部分要描述文档的目的，并指明文档的读者。1.2.适用范围1.2.1.软件名称1.2.2.软件功能解释软件产品将完成或不完成的功能1.2.3.软件应用描述软件的应用领域1.3.定义及关键词表1.关键词关键词英文全名中文解释1.4.参考资料1名师资料总结-精品资料欢迎下载-名师精心整理-第 5 页，共 10 页 -详细设计说明书第 6 页 共 10 页2.子模块 1 设计描述2.1.类 xxx 的设计2.1.1.简介如果在概要设计中未说明，则在此详细描述类的职责和功能，可使用顺序图、协作图、状态图来详细描述。必要时，可描述本类与相关类之间的静态动态关系。2.1.2.类图图1类图 xxx-class 2.1.3.状态设计（可选）可以用状态图来描述类的状态信息。2.1.4.属性可先定义相关的数据结构，再对属性进行描述。也可以不使用表格、而使用伪代码格式。表2.类XXX 的属性可见性属性名称类型说明（对属性的简短描述）Private Public Protected 2.1.5.方法1.方法 xxx 1)方法描述Java 的函数头注释采用JavaDoc 自动生成的格式：/*functions 增删改查 XXX*param String name 名字*return true 如果不为空则返回真，false 如果为空返回假*throws 无*/C+使用以下格式：名师资料总结-精品资料欢迎下载-名师精心整理-第 6 页，共 10 页 -详细设计说明书第 7 页 共 10 页表3.方法描述 xxx-function 函数原型方法的声明，包含可见性功能描述描述本方法的功能被调函数被本函数调用的函数清单（非系统函数）主调函数调用本函数的函数清单（非系统函数）,可选输入参数描述每个输入参数的含义、内存管理原则（谁分配、谁释放）输出参数描述每个输出参数的含义、内存管理原则（谁分配、谁释放）返回值描述返回值的含义抛出异常描述可能抛出的异常2)实现描述（使用伪代码、流程图等来描述本方法的详细实现。这部分是详细设计的重点。可以在开发工具中编写后再将文件嵌入到文档中。伪代码请直接写成注释格式，减少编码阶段的注释工作量）initial()getValue()value 1?NewActivity2NewActivity3yesno图2流程图 xxx-function void TestTask:iMapTaskCmdRecv(CmdMSG*CmdMsg)_US command=CmdMsg-CmdCode;名师资料总结-精品资料欢迎下载-名师精心整理-第 7 页，共 10 页 -详细设计说明书第 8 页 共 10 页/生成应答数据帧空间/获得任务的ID Switch(command)case 0 x01:/填写对应的业务字段和数据break;case 0 x02:/填写对应的业务字段和数据break;default:break;/发送应答数据帧/设置任务状态为TASK_STATE_WAITNEXT 2.方法 xxx 1)方法描述名师资料总结-精品资料欢迎下载-名师精心整理-第 8 页，共 10 页 -详细设计说明书第 9 页 共 10 页3.数据库详细设计（可选）描述存储过程、触发器等的详细实现。3.1.存储过程#/触发器#的名称1.描述原型原型描述功能描述描述实现的功能使用的数据库对象说明使用到的相关数据库对象（表、其它存储过程、视图等）输入参数描述每个输入参数的含义输出参数描述每个输出参数的含义返回值描述返回值的含义2.实现描述使用伪代码来描述详细实现。名师资料总结-精品资料欢迎下载-名师精心整理-第 9 页，共 10 页 -详细设计说明书第 10 页 共 10 页4.错误处理4.1.系统错误比如：内存分配失败、任务创建失败等错误是如何被处理的4.2.接口错误描述将要产生并给外部实体用的错误码4.3.协议错误描述在协议中没有描述的情况如何处理。（可选）名师资料总结-精品资料欢迎下载-名师精心整理-第 10 页，共 10 页 -