软件模块详细设计实用模板.docx
《软件模块详细设计实用模板.docx》由会员分享，可在线阅读，更多相关《软件模块详细设计实用模板.docx（24页珍藏版）》请在冰点文库上搜索。
软件模块详细设计实用模板
技术文件
技术文件名称：
技术文件编号：
版本：
拟制
审核
会签
标准化
批准
中兴软件技术（南昌）有限公司
版本变更记录
文件编号
版本号
拟制人/修改人
拟制/修改日期
更改理由
主要更改内容
（写要点即可）
注1：
每次更改归档文件（指归档发布数据库）时，需填写此表。
注2：
文件第一次归档时，“更改理由”、“主要更改内容”栏写“无”。
<
说明
⏹本模版中用“<>”引起来的蓝色斜体字为撰写模版内容的使用说明或解释，请在完成之后删除这部分内容。
⏹本模版中列出应该填写内容框架，为了通用则不可避免牺牲应对具体情况的灵活性，若其中部分栏目的内容不适用，则必须在该栏目中填写“无”，禁止删除栏目或空白，以免产生缺失或遗漏的误导。
⏹本模版的解释权归公司技术管理部所有。
>
1引言
1.1编写目的
定义需求开发和管理的相关约定和活动。
1.2适用范围
适用于需求开发和管理。
1.3预期读者和阅读建议
预期读者和阅读建议见表1。
表1
读者分类
阅读重点
备注
无
1.4参考资料
无。
1.5引用标准文件
无。
2术语、定义与缩略语
2.1术语、定义
术语、定义见表2
表2
术语/定义
说明
无
2.2缩略语
缩略语见表3。
表3
缩略语
原文
中文含义
无
3用户管理模块
3.1模块描述
<要求：
从模块在系统中的位置，实现原理及方式、实现的主要功能等方面来描述该模块的概貌。
>
实现的原理及方式：
实现的主要功能：
查找好友：
用户能够根据自己的需求对在线的用户进行查找。
添加好友：
用户可以把查找到的好友添加到自己的好友列表里面，从而可以和好友进行通讯。
删除好友：
用户也可以对自己不想要通讯的用户进行删除。
3.2标准模块（可选）
<要求：
说明在产品模块库、事业部模块库中对标准模块查询结果、指出引用的标准模块的内容和应用方式、描述本模块中可能抽象的公用模块及其应用范围>
Z模块设计
<要求：
主要用文字、图表等形式详细描述该模块的状态迁移、信号流程、程序流程、界面安排、进程关系、异常处理、错误处理等方面。
详细说明本模块中的可测试性设计，包括提供的测试接口，测试内容和范围等。
>
3.3类定义
3.3.1CSearchUser
3.3.1.1描述
<要求：
简述此类下列相关内容：
●实现功能
●在模块中起到的作用
●引用此类应注意的事项。
>
实现功能：
3.3.1.2引用包列表或头文件
<要求：
简述此类下列相关内容：
例如：
java.util.Vector
com.ztenc.xxx
。
>
3.3.1.3继承（实现）关系
<要求：
继承（实现）的类（接口）的包的完整路径。
例如：
java.util.Vector>
3.3.1.4属性
<要求：
描述属性名称、含义、数据类型、访问类型、修饰符以及初始值。
>
3.3.1.4.1m_UserID
●含义
<例如：
用户名。
>
用户ID
●数据类型
<例如：
java.lang.String。
>
●访问类型
<例如：
private。
>
public
●修饰符
<例如：
无。
>
●初始值
<例如：
null。
>
3.3.1.4.2m_UserName
●含义
<例如：
用户名。
>
用户昵称
●数据类型
<例如：
java.lang.String。
>
●访问类型
<例如：
private。
>
public
●修饰符
<例如：
无。
>
●初始值
<例如：
null。
>
3.3.1.4.3m_Password
●含义
<例如：
用户名。
>
用户密码
●数据类型
<例如：
java.lang.String。
>
●访问类型
<例如：
private。
>
public
●修饰符
<例如：
无。
>
●初始值
<例如：
null。
>
3.3.1.4.4m_Popedom
●含义
<例如：
用户名。
>
用户权限
●数据类型
<例如：
java.lang.String。
>
●访问类型
<例如：
private。
>
public
●修饰符
<例如：
无。
>
●初始值
<例如：
null。
>
3.3.1.4.5m_Remark
●含义
<例如：
用户名。
>
保存备注
●数据类型
<例如：
java.lang.String。
>
●访问类型
<例如：
private。
>
public
●修饰符
<例如：
无。
>
●初始值
<例如：
null。
>
3.3.1.5方法
3.3.1.5.1voidCSearchUser:
:
OnSearchUser（）
●功能描述
显示“查找/添加用户”对话框，根据用户设定的用户帐号、昵称等信息查找所有在线用户。
●访问类型
<例如：
private。
>
private
●修饰符
<例如：
static。
>
●输入
<要求：
给出本函数的输入参数的详细说明,包括取值范围、含义，及参数间的控制、顺序、独立或依赖等关系。
>
●算法与处理流程
<要求：
说明本函数的关键实现方法与处理流程。
明确对程序的注释。
规定对信息是否有特殊的编码要求。
>
1、声明一个CUser对象
2、声明一个CUserManage对象
3、调用CUser对象的SetUserID（CStringm_UserID）等方法将输入的用户信息；
4、使用一个if语句调用CUserManage对象的IsExist（CStringm_UserID）方法检验输入的用户信息是否有效，有效的话，弹出一个MessageBox（）对话框，确定的话执行就调用CUserManage对象的SearchUser（CUseruser）方法查找一个新用户，否则不做任何操作
●输出
<要求：
给出本函数的输出参数的详细说明。
它主要包括它的输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系。
>
●返回
<要求：
说明返回值的含义。
>
3.3.2CAddUser
3.3.2.1描述
<要求：
简述此类下列相关内容：
●实现功能
●在模块中起到的作用
●引用此类应注意的事项。
>
3.3.2.2引用包列表或头文件
<要求：
简述此类下列相关内容：
例如：
java.util.Vector
com.ztenc.xxx
。
>
3.3.2.3继承（实现）关系
<要求：
继承（实现）的类（接口）的包的完整路径。
例如：
java.util.Vector>
3.3.2.4属性
<要求：
描述属性名称、含义、数据类型、访问类型、修饰符以及初始值。
>
3.3.2.4.1m_UserID
●含义
<例如：
用户名。
>
用户ID
●数据类型
<例如：
java.lang.String。
>
●访问类型
<例如：
private。
>
public
●修饰符
<例如：
无。
>
●初始值
<例如：
null。
>
3.3.2.4.2m_UserName
●含义
<例如：
用户名。
>
用户昵称
●数据类型
<例如：
java.lang.String。
>
●访问类型
<例如：
private。
>
public
●修饰符
<例如：
无。
>
●初始值
<例如：
null。
>
3.3.2.4.3m_Password
●含义
<例如：
用户名。
>
用户密码
●数据类型
<例如：
java.lang.String。
>
●访问类型
<例如：
private。
>
public
●修饰符
<例如：
无。
>
●初始值
<例如：
null。
>
3.3.2.4.4m_Popedom
●含义
<例如：
用户名。
>
用户权限
●数据类型
<例如：
java.lang.String。
>
●访问类型
<例如：
private。
>
public
●修饰符
<例如：
无。
>
●初始值
<例如：
null。
>
3.3.2.4.5m_Remark
●含义
<例如：
用户名。
>
保存备注
●数据类型
<例如：
java.lang.String。
>
●访问类型
<例如：
private。
>
public
●修饰符
<例如：
无。
>
●初始值
<例如：
null。
>
3.3.2.5方法
3.3.2.5.1voidCAddUser:
:
OnAddUser（）
●功能描述
显示“查找/添加用户”对话框，根据用户设定的用户帐号、昵称等信息或者查找到的用户信息，在数据库中新增一条用户记录。
以后在用户的好友列表中就会显示新增的好友。
●访问类型
<例如：
private。
>
private
●修饰符
<例如：
static。
>
●输入
<要求：
给出本函数的输入参数的详细说明,包括取值范围、含义，及参数间的控制、顺序、独立或依赖等关系。
>
●算法与处理流程
<要求：
说明本函数的关键实现方法与处理流程。
明确对程序的注释。
规定对信息是否有特殊的编码要求。
>
1、声明一个CUser对象
2、声明一个CUserManage对象
3、调用CUser对象的SetUserID（CStringm_UserID）等方法将输入的用户新增信息保存到CUser对象的各个成员变量中；
4、使用一个if语句调用CUserManage对象的IsExist（CStringm_UserID）方法检验输入的用户信息是否有效，有效的话，弹出一个MessageBox（）对话框，询问用户是否添加新用户，确定的话执行就调用CUserManage对象的AddUser（CUseruser）方法添加一个新用户，否则不做任何修改
●输出
<要求：
给出本函数的输出参数的详细说明。
它主要包括它的输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系。
>
●返回
<要求：
说明返回值的含义。
>
3.3.3CDelUser
3.3.3.1描述
<要求：
简述此类下列相关内容：
●实现功能
●在模块中起到的作用
●引用此类应注意的事项。
>
3.3.3.2引用包列表或头文件
<要求：
简述此类下列相关内容：
例如：
java.util.Vector
com.ztenc.xxx
。
>
3.3.3.3继承（实现）关系
<要求：
继承（实现）的类（接口）的包的完整路径。
例如：
java.util.Vector>
3.3.3.4属性
<要求：
描述属性名称、含义、数据类型、访问类型、修饰符以及初始值。
>
3.3.3.4.1m_UserID
●含义
<例如：
用户名。
>
用户ID
●数据类型
<例如：
java.lang.String。
>
●访问类型
<例如：
private。
>
private
●修饰符
<例如：
无。
>
●初始值
<例如：
null。
>
3.3.3.4.2m_UserName
●含义
<例如：
用户名。
>
用户昵称
●数据类型
<例如：
java.lang.String。
>
●访问类型
<例如：
private。
>
private
●修饰符
<例如：
无。
>
●初始值
<例如：
null。
>
3.3.3.4.3m_Password
●含义
<例如：
用户名。
>
用户密码
●数据类型
<例如：
java.lang.String。
>
●访问类型
<例如：
private。
>
private
●修饰符
<例如：
无。
>
●初始值
<例如：
null。
>
3.3.3.4.4m_Popedom
●含义
<例如：
用户名。
>
用户权限
●数据类型
<例如：
java.lang.String。
>
●访问类型
<例如：
private。
>
private
●修饰符
<例如：
无。
>
●初始值
<例如：
null。
>
3.3.3.4.5m_UserList
●含义
<例如：
用户名。
>
列表控件变量
●数据类型
<例如：
java.lang.String。
>
●访问类型
<例如：
private。
>
private
●修饰符
<例如：
无。
>
●初始值
<例如：
null。
>
3.3.3.4.6m_Index
●含义
<例如：
用户名。
>
选定的用户记录
●数据类型
<例如：
java.lang.String。
>
●访问类型
<例如：
private。
>
private
●修饰符
<例如：
无。
>
●初始值
<例如：
null。
>
3.3.3.4.7m_CUserList
●含义
<例如：
用户名。
>
保存用户列表信息
●数据类型
<例如：
java.lang.String。
>
●访问类型
<例如：
private。
>
private
●修饰符
<例如：
无。
>
●初始值
<例如：
null。
>
3.3.3.5方法
3.3.3.5.1voidCDelUser:
:
OnInitDialog（）
●功能描述
显示用户列表。
●访问类型
<例如：
private。
>
public
●修饰符
<例如：
static。
>
●输入
<要求：
给出本函数的输入参数的详细说明,包括取值范围、含义，及参数间的控制、顺序、独立或依赖等关系。
>
●算法与处理流程
<要求：
说明本函数的关键实现方法与处理流程。
明确对程序的注释。
规定对信息是否有特殊的编码要求。
>
1、声明一个CUserManage对象
2、调用CUserManage对象的GetUserList（CArray*UserList）方法获取数据库里用户列表
3、使用一个for循环逐条显示用户列表
●输出
<要求：
给出本函数的输出参数的详细说明。
它主要包括它的输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系。
>
●返回
<要求：
说明返回值的含义。
>
3.3.3.5.2voidCDelUser:
:
OnClickList（NMHDR*pNMHDR,LRESULT*pResult）
●功能描述
选择用户
●访问类型
<例如：
private。
>
public
●修饰符
<例如：
static。
>
●输入
<要求：
给出本函数的输入参数的详细说明,包括取值范围、含义，及参数间的控制、顺序、独立或依赖等关系。
>
●算法与处理流程
<要求：
说明本函数的关键实现方法与处理流程。
明确对程序的注释。
规定对信息是否有特殊的编码要求。
>
1、声明一个整型变量m_index，作为一个索引
2、调用列表控件成员变量m_userlist的GetSelectionMark（）方法，获得在列表中选中的用户，并将GetSelectionMark（）方法的返回值赋给m_index
3、调用列表控件成员变量m_userlist的GetItemText（index,N）方法，将选中的用户信息保存到输入框变量中
●输出
<要求：
给出本函数的输出参数的详细说明。
它主要包括它的输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系。
>
●返回
<要求：
说明返回值的含义。
>
3.3.3.5.3voidCDelUser:
:
OnDelUser（）
●功能描述
删除用户信息
●访问类型
<例如：
private。
>
public
●修饰符
<例如：
static。
>
●输入
<要求：
给出本函数的输入参数的详细说明,包括取值范围、含义，及参数间的控制、顺序、独立或依赖等关系。
>
●算法与处理流程
<要求：
说明本函数的关键实现方法与处理流程。
明确对程序的注释。
规定对信息是否有特殊的编码要求。
>
1、弹出一个MessageBox（）对话框，询问用户是否删除，确定的话执行以下步骤，否则不做修改
2、声明一个CUser对象
3、声明一个CUserManage对象
4、调用CUserManage对象的DelUser（CStringUserID）删除数据库里的用户
●输出
<要求：
给出本函数的输出参数的详细说明。
它主要包括它的输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系。
>
●返回
<要求：
说明返回值的含义。
>
3.4单元定义（可选）
<说明：
此处定义项目中web页面（asp、jsp）或其它脚本语言的详细设计。
单元是指一张页面或一个独立的文件中：
●一段完整的代码（如jsp）；
●一个函数（如javascript）。
>
3.4.1单元一
3.4.1.1名称
<例如：
login.jsp。
>
3.4.1.2功能描述
<例如：
用户登录。
>
3.4.1.3输入
<要求：
给出本函数的输入参数的详细说明,包括取值范围、含义，及参数间的控制、顺序、独立或依赖等关系。
如果是非函数（如jsp），则为无。
>
3.4.1.4算法与处理流程
<要求：
说明本函数的关键实现方法与处理流程。
明确对程序的注释。
规定对信息是否有特殊的编码要求。
>
3.4.1.5输出
<要求：
给出本函数的输出参数的详细说明。
它主要包括它的输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系。
如果是非函数（如jsp），则为无。
>
3.4.1.6返回
<要求：
说明返回值的含义。
如果是非函数（如jsp），则为无。
>
升级会员 