软件模块详细设计模板

1、技术文件名称：vXXX技术文件编号:本:标准化批准中兴软件技术（南昌）有限公司版本变更记录注1:每次更改归档文件（指归档发布数据库）时，需填写此表。注2:文件第一次归档时，“更改理由”、“主要更改内容”栏写尢 。目录版本变更记录 目录引言编写目的 适用范围 预期读者和阅读建议 参考资料 引用标准文件术语、定义与缩略语术语、定义 缩略语模块一模块描述 标准模块（可选） 模块设计 类定义类一单元定义（可选）单元一无本模版中用“”引起来的蓝色斜体字为撰写模版内容的使用 说明或解释，请在完成之后删除这部分内容。本模版中列出应该填写内容框架，为了通用则不可避免牺牲应 对具体情况的灵活性，若其中部分栏目的

2、内容不适用，则必须 在该栏目中填写“无”，禁止删除栏目或空白，以免产生缺失 或遗漏的误导。本模版的解释权归公司技术管理部所有。1.1编写目的定义VXXX项目 需求开发和管理的相关约定和活动。1.2适用范围适用于VXXX项目 需求开发和管理。1.3预期读者和阅读建议表1预期读者和阅读建议见表1。1.4参考资料无。1.5引用标准文件无。2术语、定义与缩略语2.1术语、定义术语、定义见表2表2无2.2缩略语缩略语见表3。表3无3 用户管理模块3.1 模块描述要求：从模块在系统中的位置，实现原理及方式、实现的主要功能 等方面来描述该模块的概貌。 实现的原理及方式： 实现的主要功能：查找好友：用户能够根

3、据自己的需求对在线的用户进行查找。添加好友：用户可以把查找到的好友添加到自己的好友列表里面，从而可以和好友进行通讯。删除好友：用户也可以对自己不想要通讯的用户进行删除。3.2 标准模块（可选）要求：说明在产品模块库、事业部模块库中对标准模块查询结果、 指出引用的标准模块的内容和应用方式、描述本模块中可能抽象的公 用模块及其应用范围Z 模块设计要求：主要用文字、图表等形式详细描述该模块的状态迁移、信号 流程、程序流程、界面安排、进程关系、异常处理、错误处理等方面。详细说明本模块中的可测试性设计，包括提供的测试接口，测试内容 和范围等。 3.3类定义3.3.1 CSearchUser3.3.1.1

4、 描述V要求：简述此类下列相关内容:实现功能 在模块中起到的作用 引用此类应注意的事项。实现功能:3.3.1.2引用包列表或头文件V要求：简述此类下列相关内容:例如:3.3.1.3继承（实现）关系V要求：继承（实现）的类（接口）的包的完整路径。3.3.1.4 属性V要求：描述属性名称、含义、数据类型、访问类型、修饰符以 及初始值。3.3.1.4.1 m UserID含义V例如：用户名。用户ID数据类型v例如：。数据类型V例如：Private。P ublic修饰符V例如：无。初始值V例如：null。0 m UserName含义V例如：用户名。用户昵称数据类型V例如：访问类型V例如：Private

5、。P ublic修饰符V例如：无。初始值V例如：null。1 m Password含义V例如：用户名。用户密码V例如：访问类型V例如：Private。P ublic修饰符V例如：无。初始值V例如：null。2 m_Pop edom含义V例如：用户名。用户权限数据类型V例如：访问类型V例如：Private。P ublic修饰符V例如：无。初始值V例如：null。3 m Remark含义V例如：用户名。保存备注数据类型v例如：。访问类型V例如：Private。P ublic修饰符V例如：无。初始值V例如：null。331.5方法3.3.1.5.1 void CSearchUser:O nSearc

6、hUser()功能描述显示“查找/添加用户”对话框，根据用户设定的用户帐号、昵称等信息查找所有在线用户。访问类型V例如：Private。private 修饰符V例如：static。输入V要求：给出本函数的输入参数的详细说明,包括取值范围、含义，及参数间的控制、顺序、独立或依赖等关系。算法与处理流程V要求：说明本函数的关键实现方法与处理流程。明确对程序的注释。规定对信息是否有特殊的编码要求。1、声明一个CUser对象2、声明一个CUserManage对象3、调用 CUser 对象的 SetUserlD(CString m_UserlD) 等方法将 输入的用户信息;4、使用一个 if 语句调用 C

7、UserManage对象的 lsExist(CStringm_UserID)方法检验输入的用户信息是否有效，有效的话，弹出一个MessageBox()对话框，确定的话执行就调用CUserManage寸象的 SearchUser(CUser user)方法查找一个新用户，否则不做任何操作输出V要求：给出本函数的输出参数的详细说明。它主要包括它的输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系。返回V要求：说明返回值的含义。3.3.2 CAddUser3.3.2.1 描述V要求：简述此类下列相关内容:实现功能引用此类应注意的事项。在模块中起到的作用3.322引用包列表或头文件V要求：简

8、述此类下列相关内容:例如:3.3.2.3继承（实现）关系V要求：继承（实现）的类（接口）的包的完整路径。3.3.2.4 属性V要求：描述属性名称、含义、数据类型、访问类型、修饰符以 及初始值。3.3.2.4.1 m UserID含义V例如：用户名。用户ID数据类型v例如：。访问类型V例如：Private。P ublic修饰符V例如：无。初始值33242m UserName含义V例如：用户名。V例如：null。用户昵称数据类型V例如：访问类型V例如：Private。P ublic修饰符V例如：无。初始值V例如：null。33243m Password含义V例如：用户名。用户密码数据类型V例如：访

9、问类型V例如：Private。P ublic修饰符初始值V例如：null。V例如：无。33244m_Pop edom含义V例如：用户名。用户权限数据类型V例如：访问类型V例如：Private。P ublic修饰符V例如：无。初始值V例如：null。33245m Remark含义V例如：用户名。保存备注数据类型V例如：访问类型P ublic修饰符V例如：无。V例如：Private。例如：null。3.325方法3.3.2.5.1 void CAddUser:O nAddUser()功能描述显示“查找/添加用户”对话框，根据用户设定的用户帐号、昵称等信息或者查找到的用户信息，在数据库中新增一条用户

10、记录。以后在用户的好友列表中就会显示新增的好友。访问类型例如：Private。private 修饰符例如：static。输入V要求：给出本函数的输入参数的详细说明,包括取值范围、含义，及参数间的控制、顺序、独立或依赖等关系。算法与处理流程V要求：说明本函数的关键实现方法与处理流程。明确对程序的注释。规定对信息是否有特殊的编码要求。1、声明一个CUser对象2、声明一个CUserManage对象3、调用 CUser 对象的 SetUserlD(CString m_UserlD) 等方法将输入的用户新增信息保存到CUser对象的各个成员变量中;4、使用一个 if 语句调用 CUserManage寸

11、象的 lsExist（CStringm_UserlD）方法检验输入的用户信息是否有效，有效的话，弹出一个MessageBoxO对话框，询问用户是否添加新用户，确定的 话执行就调用CUserManage对象的AddUser（CUser user）方法添加一个新用户，否则不做任何修改输出V要求：给出本函数的输出参数的详细说明。它主要包括它的输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系。返回V要求：说明返回值的含义。333 CDelUser333.1描述V要求：简述此类下列相关内容:实现功能 在模块中起到的作用 引用此类应注意的事项。3.3.3.2引用包列表或头文件V要求：简述此类下

12、列相关内容:例如:3.3.3.3继承（实现）关系V要求：继承（实现）的类（接口）的包的完整路径。333.4属性V要求：描述属性名称、含义、数据类型、访问类型、修饰符以及初始值。3.3.3.4.1 m UserID含义V例如：用户名。用户ID数据类型v例如：。访问类型V例如：Private。private修饰符V例如：无。初始值V例如：null。33342m UserName含义V例如：用户名。用户昵称数据类型v例如：。访问类型p rivate修饰符V例如：无。初始值V例如：null。33343m Password含义V例如：用户名。用户密码数据类型V例如：访问类型V例如：Private。P r

13、ivate修饰符V例如：无。初始值V例如：null。0 m_Pop edom含义V例如：用户名。用户权限数据类型V例如：数据类型V例如：Private。private修饰符V例如：无。初始值V例如：null。1 m UserList含义V例如：用户名。列表控件变量数据类型V例如：访问类型V例如：Private。private修饰符V例如：无。初始值V例如：null。2 m Index含义选定的用户记录V例如：访问类型V例如：Private。private修饰符V例如：无。初始值V例如：null。3 m CUserList含义V例如：用户名。保存用户列表信息数据类型V例如：访问类型V例如：Pri

14、vate。P rivate修饰符V例如：无。初始值V例如：null。返回333.5方法3.3.3.5.1 void CDelUser:O nin itDialog()功能描述显示用户列表。访问类型V例如：Private。public修饰符V例如：static。输入V要求：给出本函数的输入参数的详细说明,包括取值范围、含义，及参数间的控制、顺序、独立或依赖等关系。算法与处理流程V要求：说明本函数的关键实现方法与处理流程。明确对程序的注释。规定对信息是否有特殊的编码要求。1、声明一个CUserManage寸象CUserMa nage对GetUserList(CArrayVCUser,CUser*U

15、serList) 方法 获取数 据库里用户列表3、使用一个for循环逐条显示用户列表输出V要求：给出本函数的输出参数的详细说明。它主要包括它的输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系。要求：说明返回值的含义。333.5.2void CDelUser:O nClickList(NMHDR* pN MHDR,LRESULT* pResult)功能描述选择用户访问类型例如：Private。public修饰符例如：static。输入V要求：给出本函数的输入参数的详细说明,包括取值范围、含义，及参数间的控制、顺序、独立或依赖等关系。算法与处理流程V要求：说明本函数的关键实现方法与处理

16、流程。明确对程序的注释。规定对信息是否有特殊的编码要求。1、声明一个整型变量 m_index,作为一个索引 2、调用列表控件成员变量m_userlist 的GetSelectionMark()方法，获得在列表中选中的用户，并将GetSelectionMark() 方法的返回值赋给m index3、调用列表控件成员变量m_userlist的GetltemText(index,N)方法，将选中的用户信息保存到输入框变量中V要求：给出本函数的输出参数的详细说明。它主要包括它的输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系。返回要求：说明返回值的含义。3.3.3.5.3 void CDe

17、lUser:O nDelUser()功能描述删除用户信息访问类型例如：Private。public修饰符V例如：static。输入V要求：给出本函数的输入参数的详细说明，包括取值范围、含义，及参数间的控制、顺序、独立或依赖等关系。算法与处理流程V要求：说明本函数的关键实现方法与处理流程。明确对程序的注释。规定对信息是否有特殊的编码要求。1、弹出一个MessageBoxO对话框，询问用户是否删除，确定的话执行以下步骤，否则不做修改2、声明一个CUser对象3、声明一个CUserManage寸象4、调用 CUserManage寸象的 DelUser(CString UserID) 删除数据 库里的用户输出V要求：给出本函数的输出参数的详细说明。它主要包括它的输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系。返回V要求：说明返回值的含义。3.4单元定义（可选）V说明：此处定义项目中web页面（asp、jsp ）或其它脚本语言的详细设计。单元是指一张页面或一个独立的文件中:一段完整的代码（如jsp ）； 一个函数（女口 javascript ）。3.4.1 单元3.4.1.1 名称v例如：。3.4.1.2功能描述V