软件的详细设计的说明书

项目详细设计说明书xxx模块）拟制

日期

yyyy-mm-dd评审人

日期批准

日期签发

日期实用标准文案文档修订记录版本 完成人 修改内容 审核 批准 时间V0.00 创建文档精彩文档实用标准文案目 录简介61.1.编写目的..............................................................................................................................................61.2.适用范围..............................................................................................................................................61.2.1.软件名称.................................................................................................................................61.2.2.软件功能.................................................................................................................................61.2.3.软件应用.................................................................................................................................61.3.定义及关键词.....................................................................................................................................61.4.参考资料..............................................................................................................................................72.子模块1设计描述..........................................................................................................................................82.1.类xxx的设计.....................................................................................................................................82.1.1.简介.........................................................................................................................................82.1.2.类图.........................................................................................................................................82.1.3.状态设计（可选）................................................................................................................82.1.4.属性.........................................................................................................................................82.1.5.方法.........................................................................................................................................93.数据库详细设计（可选）..........................................................................................................................133.1.存储过程#/触发器#的名称..........................................................................................................134.错误处理........................................................................................................................................................144.1.系统错误...........................................................................................................................................144.2.接口错误...........................................................................................................................................144.3.协议错误...........................................................................................................................................14精彩文档实用标准文案精彩文档实用标准文案表目录表1. 关键词 6表2. 类XXX的属性 8表3. 方法描述 xxx-function 9图目录图1 类图xxx-class 8图2 流程图xxx-function 10精彩文档实用标准文案简介1.1.编写目的这部分要描述文档的目的，并指明文档的读者。1.2.适用范围软件名称软件功能解释软件产品将完成或不完成的功能软件应用描述软件的应用领域1.3.定义及关键词表1.关键词关键词 英文全名 中文解释精彩文档实用标准文案1.4.参考资料[1]精彩文档实用标准文案子模块1设计描述2.1.类xxx的设计简介如果在概要设计中未说明，则在此详细描述类的职责和功能，可使用顺序图、协作图、状态图来详细描述。必要时，可描述本类与相关类之间的静态动态关系。类图图1类图xxx-class状态设计（可选）可以用状态图来描述类的状态信息。属性可先定义相关的数据结构，再对属性进行描述。也可以不使用表格、而使用伪代码格式。表2.类XXX的属性可见性 属性名称 类型 说明（对属性的简短描述）PrivatePublicProtected精彩文档实用标准文案方法方法xxx方法描述Java的函数头注释采用 JavaDoc 自动生成的格式：/***@functions 增删改查 XXX*@param Stringname 名字*@return true 如果不为空则返回真， false 如果为空返回假*@throws 无*/C++使用以下格式：表3.方法描述xxx-function函数原型 方法的声明，包含可见性功能描述 描述本方法的功能被调函数 被本函数调用的函数清单（非系统函数）主调函数 调用本函数的函数清单（非系统函数） ,可选输入参数 描述每个输入参数的含义、内存管理原则（谁分配、谁释放）输出参数 描述每个输出参数的含义、内存管理原则（谁分配、谁释放）返回值 描述返回值的含义抛出异常 描述可能抛出的异常精彩文档实用标准文案实现描述（使用伪代码、流程图等来描述本方法的详细实现。这部分是详细设计的重点。可以在开发工具中编写后再将文件嵌入到文档中。 伪代码请直接写成注释格式， 减少编码阶段的注释工作量）initial()getValue()no yesvalue>1?NewActivity NewActivity23图2流程图xxx-functionvoidTestTask::iMapTaskCmdRecv(CmdMSG*CmdMsg){_US command=CmdMsg->CmdCode;生成应答数据帧空间精彩文档实用标准文案获得任务的IDSwitch(command){case0x01:填写对应的业务字段和数据break;case0x02:填写对应的业务字段和数据break;default:break;}发送应答数据帧设置任务状态为TASK_STATE_WAITNEXT}方法xxx方法描述精彩文档实用标准文案精彩文档实用标准文案数据库详细设计（可选）描述存储过程、触发器等的详细实现。3.1.存储过程#/触发器#