成都启迪信息技术有限公司
软件模块详细
设计
领导形象设计圆作业设计ao工艺污水处理厂设计附属工程施工组织设计清扫机器人结构设计
模板
个人简介word模板免费下载关于员工迟到处罚通告模板康奈尔office模板下载康奈尔 笔记本 模板 下载软件方案模板免费下载
目录
目录 ii
1 引言 1
1.1 编写目的 1
1.2 适用范围 1
1.3 预期读者和阅读建议 1
1.4 参考资料 1
1.5 引用标准文件 1
2 术语、定义与缩略语 2
2.1 术语、定义 2
2.2 缩略语 2
3 角色与职责 2
4 XX模块 3
4.1 模块描述 3
4.2 标准模块(可选) 3
4.3 模块设计 3
4.4 类定义 3
4.4.1 < XX类> 3
4.4.2 < XX类> 5
4.5 函数定义(可选) 5
4.5.1 < XX函数> 5
4.5.2 < XX函数> 5
4.6 页文件(可选) 5
4.6.1
5
5 XX模块 6
软件模块详细设计模板
1 引言
1.1 编写目的
定义模块详细设计约定和活动。
1.2 适用范围
适用于模块详细设计。
1.3 预期读者和阅读建议
预期读者和阅读建议见下
表
关于同志近三年现实表现材料材料类招标技术评分表图表与交易pdf视力表打印pdf用图表说话 pdf
。
表 1 阅读建议
读者分类
阅读重点
备注
1.4 参考资料
SW-SE-CMMI1.2
1.5 引用标准文件
无。
2 术语、定义与缩略语
2.1 术语、定义
表 2 术语、定义
术语、定义
说明
2.2 缩略语
表 3 缩略语
缩略语
原文
说明
3 角色与职责
表 4 角色与职责
角色
职责
<编写注意,为避免详细设计内容过于宽泛而导致核心设计不突出,因此详细设计覆盖的范围请设计人员把握以下原则:
● 体系架构相关
● 核心算法相关
● 核心业务相关>
4 XX模块
4.1 模块描述
<要求:从模块在系统中的位置,实现原理及方式、实现的主要功能等方面来描述该模块的概貌。>
4.2 标准模块(可选)
<要求:说明在产品模块库、事业部模块库中对标准模块查询结果、指出引用的标准模块的内容和应用方式、描述本模块中可能抽象的公用模块及其应用范围>
4.3 模块设计
<要求:主要用文字、图表等形式详细描述该模块的状态迁移、信号流程、程序流程、界面安排、进程关系、异常处理、错误处理等方面。
详细说明本模块中的可测试性设计,包括提供的测试接口,测试内容和范围等。>
4.4 类定义
4.4.1 < XX类>
4.4.1.1 描述
<要求:简述此类下列相关内容:
● 实现功能
● 在模块中起到的作用
● 引用此类应注意的事项。>
4.4.1.2 引用包列表或头文件
<要求:简述此类下列相关内容:
例如:
java.util.Vector
com.ztenc.xxx
。>
4.4.1.3 继承(实现)关系
<要求:继承(实现)的类(接口)的包的完整路径。例如:java.util.Vector>
4.4.1.4 属性
<要求:描述属性名称、含义、数据类型、访问类型、修饰符以及初始值。>
<属性一>
● 含义
<例如:用户名。>
● 数据类型
<例如:java.lang.String。>
● 访问类型
<例如:private。>
● 修饰符
<例如:无。>
● 初始值
<例如:null。>
4.4.1.5
方法
快递客服问题件处理详细方法山木方法pdf计算方法pdf华与华方法下载八字理论方法下载
<方法一>
● 功能描述
● 访问类型
<例如:private。>
● 修饰符
<例如:static。>
● 输入
<要求:给出本函数的输入参数的详细说明, 包括取值范围、含义,及参数间的控制、顺序、独立或依赖等关系。>
● 算法与处理流程
<要求:说明本函数的关键实现方法与处理流程。明确对程序的注释。规定对信息是否有特殊的编码要求。>
● 输出
<要求:给出本函数的输出参数的详细说明。它主要包括它的输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系。>
● 返回
<要求:说明返回值的含义。>
4.4.1.6 测试点
<要求:描述需要测试的功能、性能等 >
4.4.2 < XX类>
4.5 函数定义(可选)
<说明:此处定义项目中web页面脚本语言的详细设计。>
4.5.1 < XX函数>
4.5.1.1 功能描述
<例如:用户登录。>
4.5.1.2 参数定义
<要求:给出本函数的输入参数的详细说明, 包括取值范围、含义,及参数间的控制、顺序、独立或依赖等关系。
如果是非函数(如jsp),则为无。>
4.5.1.3 算法与处理流程
<要求:说明本函数的关键实现方法与处理流程。明确对程序的注释。规定对信息是否有特殊的编码要求。>
4.5.1.4 返回
<要求:说明返回值的含义。
如果是非函数(如jsp),则为无。
>
4.5.1.5 测试点
<要求:描述需要测试的功能、性能等 >
4.5.2 < XX函数>
4.6 页文件(可选)
4.6.1
4.6.1.1 功能描述
<例如:用户登录。>
4.6.1.2 算法与处理流程
<要求:说明本函数的关键实现方法与处理流程。明确对程序的注释。规定对信息是否有特殊的编码要求。>
4.6.1.3 调用关系
4.6.1.4 测试点
<要求:描述需要测试的功能、性能等 >
5 XX模块