软件详细设计项目说明指导书.doc

xxx项目具体设计说明书（xxx模块）拟制日期yyyy-mm-dd评审人日期同意日期签发日期文档修订统计版本完成人修改内容审核同意时间V0.00创建文档目 录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表目录表1.关键词4表2.类XXX属性5表3.方法描述xxx-function6图目录图1类图xxx-class5图2步骤图xxx-function61. 介绍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. 介绍假如在概要设计中未说明，则在此具体描述类职责和功效，可使用次序图、协作图、状态图来具体描述。必需时，可描述本类和相关类之间静态动态关系。2.1.2. 类图图1 类图xxx-class2.1.3. 状态设计（可选）能够用状态图来描述类状态信息。2.1.4. 属性可先定义相关数据结构，再对属性进行描述。也能够不使用表格、而使用伪代码格式。表2. 类XXX属性可见性属性名称类型说明（对属性简短描述）PrivatePublicProtected2.1.5. 方法1. 方法xxx1) 方法描述Java函数头注释采取JavaDoc自动生成格式：/* functions 增删改查XXX* param String name 名字* return true 假如不为空则返回真，false 假如为空返回假* throws 无*/C+使用以下格式：表3. 方法描述xxx-function函数原型方法申明，包含可见性功效描述描述本方法功效被调函数被本函数调用函数清单（非系统函数）主调函数调用本函数函数清单（非系统函数）, 可选输入参数描述每个输入参数含义、内存管理标准（谁分配、谁释放）输出参数描述每个输出参数含义、内存管理标准（谁分配、谁释放）返回值描述返回值含义抛出异常描述可能抛出异常2) 实现描述（使用伪代码、步骤图等来描述本方法具体实现。这部分是具体设计关键。能够在开发工具中编写后再将文件嵌入到文档中。伪代码请直接写成注释格式，降低编码阶段注释工作量）图2 步骤图xxx-functionvoid TestTask:iMapTaskCmdRecv (CmdMSG *CmdMsg) _US command = CmdMsg-CmdCode; /生成应答数据帧空间 /取得任务ID Switch (command) case 0x01: /填写对应业务字段和数据 break; case 0x02: /填写对应业务字段和数据 break; default: break; /发送应答数据帧 /设置任务状态为TASK_STATE_WAITNEXT2. 方法xxx1) 方法描述3. 数据库具体设计（可选）描述存放过程、触发器等具体实现。3.1. 存放过程#/触发器#名称1. 描述原型原型描述功效描述描述实现功效使用数据库对象说明使用到相关数据库对象（表、其它存放过程、视图等）输入参数描述每个输入参数含义输出参数描述每个输出参数含义返回值描述返回值含义2. 实现描述使用伪代码来描述具体实现。4. 错误处理4.1. 系统错误比如：内存分配失败、任务创建失败等错误是怎样被处理4.2. 接口错误描述将要产生并给外部实体用错误码4.3. 协议错误描述在协议中没有描述情况怎样处理。（可选）