软件详细设计说明书.docxVIP

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