《软件详细设计说明书.pdf》由会员分享，可在线阅读，更多相关《软件详细设计说明书.pdf（17页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、软件详细设计说明书软件详细设计说明书软件详细设计说明书软件详细设计说明书xxxxxx项目详细设计说明书项目详细设计说明书（xxxxxx模块）模块）拟制拟制评审人评审人批准批准签发签发yyyy-mm-ddyyyy-mm-dd日期日期日期日期日期日期日期日期详细设计说明书详细设计说明书文档修订记录文档修订记录版本版本V0.00V0.00完成完成人人修改内容修改内容创建文档创建文档审核审核批准批准时间时间第第 4 4 页页 共共 17 17 页页详细设计说明书详细设计说明书目目录录1.1.简介简介.8 81.1.1.1.编写目的编写目的.8 81.2.1.2.适用范围适用范围.8 81.2.1.1.
2、2.1.软件名称软件名称.8 81.2.2.1.2.2.软件功能软件功能.8 81.2.3.1.2.3.软件应用软件应用.8 81.3.1.3.定义及关键词定义及关键词.8 81.4.1.4.参考资料参考资料.8 82.2.子模块子模块 1 1 设计描述设计描述.10102.1.2.1.类类 xxxxxx 的设计的设计.10102.1.1.2.1.1.简介简介.10102.1.2.2.1.2.类图类图.10102.1.3.2.1.3.状态设计（可选）状态设计（可选）.10102.1.4.2.1.4.属性属性.10102.1.5.2.1.5.方法方法.11113.3.数据库详细设计（可选）数据库
3、详细设计（可选）.错误!未定义书签。3.1.3.1.存储过程存储过程#/#/触发器触发器#的名称的名称.错误!未定义书签。4.4.错误处理错误处理.错误!未定义书签。4.1.4.1.系统错误系统错误.错误!未定义书签。第第 5 5 页页 共共 17 17 页页详细设计说明书详细设计说明书4.2.4.2.接口错误接口错误.错误!未定义书签。4.3.4.3.协议错误协议错误.错误!未定义书签。第第 6 6 页页 共共 17 17 页页详细设计说明书详细设计说明书表目录表目录表表 1.1.关关键词键词.8 8表表 2.2.类类 XXXXXX 的属性的属性.1010表表 3.3.方方法描述法描述 xx
4、x-function.xxx-function.1111图目录图目录图图 1 1 类图类图 xxx-classxxx-class.1010图图 2 2 流程图流程图 xxx-function.xxx-function.1313第第 7 7 页页 共共 17 17 页页详细设计说明书详细设计说明书1.1.简介简介1.1.编写目的编写目的这部分要描述文档的目的，并指明文档的读者。这部分要描述文档的目的，并指明文档的读者。1.2.适用范围适用范围1.2.1.软件名称软件名称1.2.2.软件功能软件功能解释软件产品将完成或不完成的功能解释软件产品将完成或不完成的功能1.2.3.软件应用软件应用描述软件
5、的应用领域描述软件的应用领域1.3.定义及关键词定义及关键词表1.关键词关键词关键词关键词1.4.参考资料参考资料英文全名英文全名中文解释中文解释11第第 8 8 页页 共共 17 17 页页详细设计说明书详细设计说明书第第 9 9 页页 共共 17 17 页页详细设计说明书详细设计说明书2.2.子模块子模块 1 1 设计描述设计描述2.1.类类 xxxxxx 的设计的设计2.1.1.简介简介如果在概要设计中未说明，则在此详细描述类的如果在概要设计中未说明，则在此详细描述类的职责和功能，可使用顺序图、协作图、状态图来职责和功能，可使用顺序图、协作图、状态图来详细描述。必要时，可描述本类与相关类
6、之间的详细描述。必要时，可描述本类与相关类之间的静态动态关系。静态动态关系。2.1.2.类图类图图1 类图类图xxx-classxxx-class2.1.3.状态设计（可选）状态设计（可选）可以用状态图来描述类的状态信息。可以用状态图来描述类的状态信息。2.1.4.属性属性可先定义相关的数据结构，再对属性进行描述。可先定义相关的数据结构，再对属性进行描述。也可以不使用表格、而使用伪代码格式。也可以不使用表格、而使用伪代码格式。表2.类类XXXXXX的属性的属性可见性可见性属性名称属性名称 类型类型 说明说明（对属性的简短描（对属性的简短描述）述）PrivatePrivatePublicPubl
7、ic第第 10 10 页页 共共 17 17 页页详细设计说明书详细设计说明书ProtectedProtected2.1.5.方法方法1.1.方法方法 xxxxxx1)1)方法描述方法描述JavaJava 的函数头注释采用的函数头注释采用 JavaDocJavaDoc 自动生成的格自动生成的格式：式：/*/*functions*functions 增删改查增删改查 XXXXXX*param*paramString nameString name 名字名字*return*returntruetrue 如果不为空则返回真，如果不为空则返回真，falsefalse如果为空返回假如果为空返回假*thr
8、ows*throws 无无*/*/C+C+使用以下格式：使用以下格式：表3.方法描述方法描述xxx-functionxxx-function函数原型函数原型功能描述功能描述被调函数被调函数主调函数主调函数方法的声明，包含可见性方法的声明，包含可见性描述本方法的功能描述本方法的功能被本函数调用的函数清单（非系统函被本函数调用的函数清单（非系统函数）数）调用本函数的函数清单调用本函数的函数清单（非系统函数）（非系统函数）,第第 11 11 页页 共共 17 17 页页详细设计说明书详细设计说明书可选可选输入参数输入参数输出参数输出参数返回值返回值抛出异常抛出异常2)2)描述每个输入参数的含义、内存
9、管理描述每个输入参数的含义、内存管理原则（谁分配、谁释放）原则（谁分配、谁释放）描述每个输出参数的含义、内存管理描述每个输出参数的含义、内存管理原则（谁分配、谁释放）原则（谁分配、谁释放）描述返回值的含义描述返回值的含义描述可能抛出的异常描述可能抛出的异常实现描述实现描述（使用伪代码、流程图等来描述本方法的详细实（使用伪代码、流程图等来描述本方法的详细实现。这部分是详细设计的重点。可以在开发工具现。这部分是详细设计的重点。可以在开发工具中编写后再将文件嵌入到文档中。伪代码请直接中编写后再将文件嵌入到文档中。伪代码请直接写成注释格式，减少编码阶段的注释工作量）写成注释格式，减少编码阶段的注释工作
10、量）第第 12 12 页页 共共 17 17 页页详细设计说明书详细设计说明书initial()getValue()noyesvalue 1?NewActivity2NewActivity3图2 流程图流程图xxx-functionxxx-functionvoid TestTask:iMapTaskCmdRecvvoid TestTask:iMapTaskCmdRecv(CmdMSG*CmdMsg)(CmdMSG*CmdMsg)_US_UScommand=command=CmdMsg-CmdCode;CmdMsg-CmdCode;/生成应答数据帧空间生成应答数据帧空间第第 13 13 页页 共
11、共 17 17 页页详细设计说明书详细设计说明书/获得任务的获得任务的 IDIDSwitch(command)Switch(command)case 0 x01:case 0 x01:/填写对应的业务字段和数据填写对应的业务字段和数据break;break;case 0 x02:case 0 x02:/填写对应的业务字段和数据填写对应的业务字段和数据break;break;default:default:break;break;/发送应答数据帧发送应答数据帧/设置任务状态为设置任务状态为TASK_STATE_WAITNEXTTASK_STATE_WAITNEXT 第第 14 14 页页 共共 17 17 页页