软件详细设计方案说明书Word文件下载.docx
- 文档编号:15181348
- 上传时间:2022-10-28
- 格式:DOCX
- 页数:6
- 大小:23.38KB
软件详细设计方案说明书Word文件下载.docx
《软件详细设计方案说明书Word文件下载.docx》由会员分享,可在线阅读,更多相关《软件详细设计方案说明书Word文件下载.docx(6页珍藏版)》请在冰豆网上搜索。
V0.00
创建文档
1.简介5
1.1.编写目的5
1.2.适用范围5
1.2.1.软件名称5
1.2.2.软件功能5
1.2.3.软件应用5
1.3.定义及关键词5
1.4.参考资料5
2.子模块1设计描述6
2.1.类xxx的设计6
2.1.1.简介6
2.1.2.类图6
2.1.3.状态设计(可选)6
2.1.4.属性6
2.1.5.方法6
3.数据库详细设计(可选)9
3.1.存储过程#/触发器#的名称9
4.错误处理10
4.1.系统错误10
4.2.接口错误10
4.3.协议错误10
表目录
表1.关键词5
表2.类XXX的属性6
表3.方法描述xxx-function7
图目录
图1类图xxx-class6
图2流程图xxx-function7
1.简介
1.1.编写目的
这部分要描述文档的目的,并指明文档的读者。
1.2.适用范围
1.2.1.软件名称
1.2.2.软件功能
解释软件产品将完成或不完成的功能
1.2.3.软件应用
描述软件的应用领域
1.3.定义及关键词
表1.关键词
关键词
英文全名
中文解释
1.4.参考资料
[1]
2.子模块1设计描述
2.1.类xxx的设计
2.1.1.简介
如果在概要设计中未说明,则在此详细描述类的职责和功能,可使用顺序图、协作图、状态图来详细描述。
必要时,可描述本类与相关类之间的静态动态关系。
2.1.2.类图
图1类图xxx-class
2.1.3.状态设计(可选)
可以用状态图来描述类的状态信息。
2.1.4.属性
可先定义相关的数据结构,再对属性进行描述。
也可以不使用表格、而使用伪代码格式。
表2.类XXX的属性
可见性
属性名称
类型
说明(对属性的简短描述)
Private
Public
Protected
2.1.5.方法
1.方法xxx
1)方法描述
Java的函数头注释采用JavaDoc自动生成的格式:
/**
*@functions增删改查XXX
*@paramStringname名字
*@returntrue如果不为空则返回真,false如果为空返回假
*@throws无
*/
C++使用以下格式:
表3.方法描述xxx-function
函数原型
方法的声明,包含可见性
功能描述
描述本方法的功能
被调函数
被本函数调用的函数清单(非系统函数)
主调函数
调用本函数的函数清单(非系统函数),可选
输入参数
描述每个输入参数的含义、内存管理原则(谁分配、谁释放)
输出参数
描述每个输出参数的含义、内存管理原则(谁分配、谁释放)
返回值
描述返回值的含义
抛出异常
描述可能抛出的异常
2)实现描述
伪代码请直接写成注释格式,减少编码阶段的注释工作量)
(使用伪代码、流程图等来描述本方法的详细实现。
这部分是详细设计的重点。
可以在开发工具中编写后再将文件嵌入到文档中。
voidTestTask:
:
iMapTaskCmdRecv(CmdMSG*CmdMsg)
{
_UScommand=CmdMsg->
CmdCode;
//生成应答数据帧空间
〃获得任务的ID
Switch(command)
case0x01:
//填写对应的业务字段和数据
break;
case0x02:
default:
}
//发送应答数据帧
〃设置任务状态为TASK_STATE_WAITNEXT}
2.方法xxx
3.数据库详细设计(可选)
描述存储过程、触发器等的详细实现。
3.1.存储过程#/触发器#的名称
1.描述
原型
原型描述
描述实现的功能
使用的数据库对象
说明使用到的相关数据库对象(表、其它存储过程、视图等)
描述每个输入参数的含义
描述每个输出参数的含义
2.实现描述
使用伪代码来描述详细实现。
4.错误处理
4.1.系统错误
比如:
内存分配失败、任务创建失败等错误是如何被处理的
4.2.接口错误
描述将要产生并给外部实体用的错误码
4.3.协议错误
描述在协议中没有描述的情况如何处理。
(可选)
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 软件 详细 设计方案 说明书