软件详细设计说明书0.pdf

《软件详细设计说明书0.pdf》由会员分享，可在线阅读，更多相关《软件详细设计说明书0.pdf（7页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、.xxx项目详细设计说明书（xxx模块）拟制评审人批准签发日期日期日期日期yyyy-mm-dd文档修订记录版本V0.00完成人创建文档修改容审核批准时间.word.-目录1.简介 31.1.编写目的 31.2.适用围 31.2.1.软件名称 31.2.2.软件功能 31.2.3.软件应用 31.3.定义及关键词 31.4.参考资料 32.子模块 1 设计描述 32.1.类 xxx 的设计 32.1.1.简介 32.1.2.类图 42.1.3.状态设计（可选）42.1.4.属性 42.1.5.方法 43.数据库详细设计（可选）63.1.存储过程#/触发器#的名称 64.错误处理 64.1.系统错

2、误 64.2.接口错误 74.3.协议错误 7表目录表 1.关键词 3表 2.类 XXX 的属性 4表 3.方法描述 xxx-function.4图目录图 1 类图 xxx-class.4图 2 流程图 xxx-function.5.可修编.-1.简介1.1.编写目的这部分要描述文档的目的，并指明文档的读者。1.2.适用围1.2.1.软件名称1.2.2.软件功能解释软件产品将完成或不完成的功能1.2.3.软件应用描述软件的应用领域1.3.定义及关键词表1.关键词关键词英文全名中文解释1.4.参考资料12.子模块 1 设计描述2.1.类 xxx 的设计2.1.1.简介如果在概要设计中未说明，则在

3、此详细描述类的职责和功能，可使用顺序图、协作图、状态图来详细描述。必要时，可描述本类与相关类之间的静态动态关系。.可修编.-2.1.2.类图图1类图xxx-class2.1.3.状态设计（可选）可以用状态图来描述类的状态信息。2.1.4.属性可先定义相关的数据结构，再对属性进行描述。也可以不使用表格、而使用伪代码格式。表2.类XXX的属性可见性PrivatePublicProtected属性名称类型说明（对属性的简短描述）2.1.5.方法1.方法 xxx1)方法描述Java 的函数头注释采用 JavaDoc 自动生成的格式：/*functions 增删改查 XXX*paramString na

4、me 名字*returntrue 如果不为空则返回真，false 如果为空返回假*throws 无*/C+使用以下格式：表3.方法描述xxx-function函数原型功能描述被调函数主调函数输入参数方法的声明，包含可见性描述本方法的功能被本函数调用的函数清单（非系统函数）调用本函数的函数清单（非系统函数）,可选描述每个输入参数的含义、存管理原则（谁分配、谁释放）.可修编.-输出参数返回值抛出异常2)实现描述描述每个输出参数的含义、存管理原则（谁分配、谁释放）描述返回值的含义描述可能抛出的异常（使用伪代码、流程图等来描述本方法的详细实现。这部分是详细设计的重点。可以在开发工具中编写后再将文件嵌入

5、到文档中。伪代码请直接写成注释格式，减少编码阶段的注释工作量）initial()getValue()noyesvalue 1?NewActivityNewActivity23图2流程图xxx-functionvoid TestTask:iMapTaskCmdRecv(CmdMSG*CmdMsg)_USmand=CmdMsg-CmdCode;/生成应答数据帧空间/获得任务的 IDSwitch(mand)case 0 x01:.可修编.-/填写对应的业务字段和数据break;case 0 x02:/填写对应的业务字段和数据break;default:break;/发送应答数据帧/设置任务状态为 T

6、ASK_STATE_WAITNEXT2.方法 xxx1)方法描述3.数据库详细设计（可选）描述存储过程、触发器等的详细实现。3.1.存储过程#/触发器#的名称1.描述原型功能描述使用的数据库对象输入参数输出参数返回值原型描述描述实现的功能说明使用到的相关数据库对象（表、其它存储过程、视图等）描述每个输入参数的含义描述每个输出参数的含义描述返回值的含义2.实现描述使用伪代码来描述详细实现。4.错误处理4.1.系统错误比如：存分配失败、任务创建失败等错误是如何被处理的.可修编.-4.2.接口错误描述将要产生并给外部实体用的错误码4.3.协议错误描述在协议中没有描述的情况如何处理。（可选）.可修编.