软件模块详细设计

《软件模块详细设计》由会员分享，可在线阅读，更多相关《软件模块详细设计（16页珍藏版）》请在金锄头文库上搜索。

1、技术文件技术文件名称：技术文件编号：版 本：拟制审核会签标准化批准中兴软件技术（南昌）有限公司版本变更记录注1:每次更改归档文件（指归档发布数据库）时，需填写此表。注2：文件第一次归档时，“更改理由”、“主要更改内容”栏写“无”。目录说明本模版中用“”引起来的蓝色斜体字为撰写模版内容的使用说明或解释请在完 成之后删除这部分内容。本模版中列出应该填写内容框架，为了通用则不可避免牺牲应对具体情况的灵活 性，若其中部分栏目的内容不适用，则必须在该栏目中填写“无禁止删除栏目 或空白，以免产生缺失或遗漏的误导。本模版的解释权归公司技术管理部所有。1引言11编写目的定义XXX项目需求开发和管理的相关约定和

2、活动。1.2适用范围适用于XXX项目需求开发和管理。1.3预期读者和阅读建议预期读者和阅读建议见表1。表11.4参考资料无。1.5引用标准文件无。2术语、定义与缩略语2.1术语、定义术语、定义见表2表22.2缩略语缩略语见表3。表33用户管理模块3.1模块描述要求：从模块在系统中的位置，实现原理及方式、实现的主要功能等方面来描述该模块的 概貌。实现的原理及方式：实现的主要功能：查找好友：用户能够根据自己的需求对在线的用户进行查找。添加好友：用户可以把查找到的好友添加到自己的好友列表里面，从而可以和好友进行 通讯。删除好友：用户也可以对自己不想要通讯的用户进行删除。3.2标准模块（可选）要求：说

3、明在产品模块库、事业部模块库中对标准模块查询结果、指出引用的标准模块的 内容和应用方式、描述本模块中可能抽象的公用模块及其应用范围Z模块设计要求：主要用文字、图表等形式详细描述该模块的状态迁移、信号流程、程序流程、界面 安排、进程关系、异常处理、错误处理等方面。详细说明本模块中的可测试性设计，包括提供的测试接口，测试内容和范围等。3.3类定义3.3.1 CSearchUser3.3.1.1 描述要求：简述此类下列相关内容：实现功能在模块中起到的作用引用此类应注意的事项。实现功能：3.3.1.2引用包列表或头文件要求：简述此类下列相关内容：例如：。3.3.1.3继承（实现）关系3.3.1.4要求

4、：继承（实现）的类（接口）的包的完整路径。例如属性要求：描述属性名称、含义、数据类型、访问类型、修饰符以及初始值。3.3.1.4.1 m_UserID含义例如：用户名。用户ID数据类型例如:。访问类型例如：private。public修饰符例如：无。初始值例如：null。3.3.1.4.2 m_UserName含义例如：用户名。用户昵称数据类型例如:。访问类型例如：private。 public 修饰符例如：无。 初始值例如：null。3.3.1.4.3 m_Password含义例如：用户名。 用户密码 数据类型例如:。访问类型例如：private。 public 修饰符例如：无。 初始值例如

5、：null。3.3.1.4.4 m_Popedom含义例如：用户名。用户权限数据类型例如:。访问类型例如：private。 public 修饰符例如：无。初始值例如：null。3.3.1.4.5 m_Remark含义例如：用户名。保存备注数据类型例如:。访问类型例如：private。public修饰符例如：无。初始值例如：null。3.3.1.5 方法3.3.1.5.1 void CSearchUser:OnSearchUser()功能描述显示“查找/添加用户”对话框，根据用户设定的用户帐号、昵称等信息查找所有在线 用户。访问类型例如：private。private修饰符例如：static。输

6、入要求：给出本函数的输入参数的详细说明包括取值范围、含义，及参数间的控 制、顺序、独立或依赖等关系。算法与处理流程要求：说明本函数的关键实现方法与处理流程。明确对程序的注释。规定对信息 是否有特殊的编码要求。1、声明一个CUser对象2、声明一个CUserManage对象3、调用CUser对象的SetUserID(CString m_UserID)等方法将输入的用户信息；4、使用一个if语句调用CUserManage对象的IsExist(CStringm_UserID)方法检验输入的用户信息是否有效，有效的话，弹出一个MessageBox()对话框，确定的话执行 就调用CUserManage对

7、象的SearchUser(CUser user)方法查找一个新用户，否则不 做任何操作输出要求：给出本函数的输出参数的详细说明。它主要包括它的输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系。返回要求：说明返回值的含义。3.3.2 CAddUser3.3.2.1 描述要求：简述此类下列相关内容：实现功能在模块中起到的作用引用此类应注意的事项。3.3.2.2引用包列表或头文件要求：简述此类下列相关内容：例如：。3.3.2.3继承（实现）关系3.3.2.4要求：继承（实现）的类（接口）的包的完整路径。例如属性 要求：描述属性名称、含义、数据类型、访问类型、修饰符以及初始值。3.3.2.

8、4.1 m_UserID含义例如：用户名。用户ID数据类型例如:。访问类型例如：private。public修饰符例如：无。初始值例如：null。3.3.2.4.2 m_UserName含义例如：用户名。用户昵称数据类型例如:。访问类型例如：private。 public 修饰符例如：无。 初始值例如：null。3.3.2.4.3 m_Password含义例如：用户名。 用户密码 数据类型例如:。访问类型例如：private。 public 修饰符例如：无。初始值例如：null。3.3.2.4.4 m_Popedom含义例如：用户名。用户权限数据类型例如:。访问类型例如：private。 pu

9、blic 修饰符例如：无。初始值例如：null。3.3.2.4.5 m_Remark含义例如：用户名。保存备注数据类型例如:。访问类型例如：private。public修饰符例如：无。初始值例如：null。3.3.2.5 方法3.3.2.5.1 void CAddUser:OnAddUser()功能描述显示“查找/添加用户”对话框，根据用户设定的用户帐号、昵称等信息或者查找到的用户信息，在数据库中新增一条用户记录。以后在用户的好友列表中就会显示新增的好友。访问类型例如：private。private修饰符例如：static。输入要求：给出本函数的输入参数的详细说明包括取值范围、含义，及参数间的

10、控 制、顺序、独立或依赖等关系算法与处理流程要求：说明本函数的关键实现方法与处理流程。明确对程序的注释。规定对信息 是否有特殊的编码要求。1、声明一个CUser对象2、声明一个CUserManage对象3、调用CUser对象的SetUserID(CString m_UserID)等方法将输入的用户新增信息保 存到CUser对象的各个成员变量中；4、使用一个if语句调用CUserManage对象的IsExist(CStringm_UserID)方法检验输 入的用户信息是否有效，有效的话，弹出一个MessageBox()对话框，询问用户是否添 加新用户，确定的话执行就调用CUserManage对象

11、的AddUser(CUser user)方法添加 一个新用户，否则不做任何修改输出要求：给出本函数的输出参数的详细说明。它主要包括它的输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系。返回要求：说明返回值的含义。3.3.3 CDelUser3.3.3.1 描述要求：简述此类下列相关内容：实现功能在模块中起到的作用引用此类应注意的事项。3.3.3.2引用包列表或头文件要求：简述此类下列相关内容：例如：。3.3.3.3继承（实现）关系3.3.3.4要求：继承（实现）的类（接口）的包的完整路径。例如属性 要求：描述属性名称、含义、数据类型、访问类型、修饰符以及初始值。3.3.3.4.1

12、m_UserID含义例如：用户名。用户ID数据类型例如:。访问类型例如：private。private修饰符例如：无。初始值例如：null。3.3.3.4.2 m_UserName含义例如：用户名。用户昵称数据类型例如:。访问类型例如：private。 private 修饰符例如：无。 初始值例如：null。3.3.3.4.3 m_Password含义例如：用户名。 用户密码 数据类型例如:。访问类型例如：private。 private 修饰符例如：无。 初始值例如：null。3.3.3.4.4 m_Popedom含义例如：用户名。 用户权限数据类型例如:。访问类型例如：private。 p

13、rivate 修饰符例如：无。 初始值例如：null。3.3.3.4.5 m_UserList含义例如：用户名。 列表控件变量数据类型例如:。访问类型例如：private。 private 修饰符例如：无。 初始值例如：null。3.3.3.4.6 m_Index含义例如：用户名。 选定的用户记录数据类型例如:。访问类型例如：private。 private 修饰符例如：无。 初始值例如：null。3.3.3.4.7 m_CUserList含义例如：用户名。保存用户列表信息 数据类型例如:。访问类型例如：private。 private 修饰符例如：无。初始值例如：null。3.3.3.5 方法3.3.3.5.1 void CDelUser:OnInitDialog()功能描述显示用户列表。访问类型例如：private。public修饰符例如：static。输入要求：给出本函数的输入参数的详细说明包括取值范围、含义，及参数间的控 制、顺序、独立或依赖等关系算