软件模块详细设计模板

技术文件技术文件名称：XXX技术文件编号：版本：拟制审核会签标准化批准中兴软件技术（南昌）有限公司内部公开▲中兴软件技术（南昌）有限公司ii版本变更记录文件编号版本号拟制人/修改人拟制/修改日期更改理由主要更改内容（写要点即可）注1：每次更改归档文件（指归档发布数据库）时，需填写此表。注2：文件第一次归档时，“更改理由”、“主要更改内容”栏写“无”。内部公开▲中兴软件技术（南昌）有限公司iii目录版本变更记录...................................................................................................................................ii目录................................................................................................................................................iii1引言.......................................................................................................................................1-21.1编写目的...................................................................................................................1-21.2适用范围...................................................................................................................1-21.3预期读者和阅读建议...............................................................................................1-21.4参考资料...................................................................................................................1-21.5引用标准文件...........................................................................................................1-22术语、定义与缩略语...........................................................................................................2-22.1术语、定义...............................................................................................................2-22.2缩略语.......................................................................................................................2-33模块一.......................................................................................................错误!未定义书签。3.1模块描述...................................................................................................................3-33.2标准模块（可选）...................................................................................................3-33.3模块设计...................................................................................................................3-33.4类定义.......................................................................................................................3-63.4.1类一...................................................................................错误!未定义书签。3.5单元定义（可选）.................................................................................................3-173.5.1单元一.........................................................................................................3-17内部公开▲中兴软件技术（南昌）有限公司1-1说明本模版中用“”引起来的蓝色斜体字为撰写模版内容的使用说明或解释，请在完成之后删除这部分内容。本模版中列出应该填写内容框架，为了通用则不可避免牺牲应对具体情况的灵活性，若其中部分栏目的内容不适用，则必须在该栏目中填写“无”，禁止删除栏目或空白，以免产生缺失或遗漏的误导。本模版的解释权归公司技术管理部所有。内部公开▲中兴软件技术（南昌）有限公司2-21引言1.1编写目的定义XXX项目需求开发和管理的相关约定和活动。1.2适用范围适用于XXX项目需求开发和管理。1.3预期读者和阅读建议预期读者和阅读建议见表1。表1读者分类阅读重点备注无1.4参考资料无。1.5引用标准文件无。2术语、定义与缩略语2.1术语、定义术语、定义见表2内部公开▲中兴软件技术（南昌）有限公司3-3表2术语/定义说明无2.2缩略语缩略语见表3。表3缩略语原文中文含义无3用户管理模块3.1模块描述要求：从模块在系统中的位置，实现原理及方式、实现的主要功能等方面来描述该模块的概貌。实现的原理及方式：实现的主要功能：查找好友：用户能够根据自己的需求对在线的用户进行查找。添加好友：用户可以把查找到的好友添加到自己的好友列表里面，从而可以和好友进行通讯。删除好友：用户也可以对自己不想要通讯的用户进行删除。3.2标准模块（可选）要求：说明在产品模块库、事业部模块库中对标准模块查询结果、指出引用的标准模块的内容和应用方式、描述本模块中可能抽象的公用模块及其应用范围Z模块设计要求：主要用文字、图表等形式详细描述该模块的状态迁移、信号流程、程序流程、界面安排、进程关系、异常处理、错误处理等方面。详细说明本模块中的可测试性设计，包括提供的测试接口，测试内容和范围等。内部公开▲中兴软件技术（南昌）有限公司3-4内部公开▲中兴软件技术（南昌）有限公司3-5内部公开▲中兴软件技术（南昌）有限公司3-63.3类定义3.3.1CSearchUser3.3.1.1描述要求：简述此类下列相关内容：实现功能在模块中起到的作用引用此类应注意的事项。实现功能：3.3.1.2引用包列表或头文件要求：简述此类下列相关内容：例如：java.util.Vectorcom.ztenc.xxx。3.3.1.3继承（实现）关系要求：继承（实现）的类（接口）的包的完整路径。例如：java.util.Vector3.3.1.4属性要求：描述属性名称、含义、数据类型、访问类型、修饰符以及初始值。3.3.1.4.1m_UserID含义例如：用户名。内部公开▲中兴软件技术（南昌）有限公司3-7用户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-83.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。内部公开▲中兴软件技术（南昌）有限公司3-9输入要求：给出本函数的输入参数的详细说明,包括取值范围、含义，及参数间的控制、顺序、独立或依赖等关系。算法与处理流程要求：说明本函数的关键实现方法与处理流程。明确对程序的注释。规定对信息是否有特殊的编码要求。1、声明一个CUser对象2、声明一个CUserManage对象3、调用CUser对象的SetUserID(CStringm_UserID)等方法将输入的用户信息；4、使用一个if语句调用CUserManage对象的IsExist(CStringm_UserID)方法检验输入的用户信息是否有效，有效的话，弹出一个MessageBox()对话框，确定的话执行就调用CUserManage对象的SearchUser(CUseruser)方法查找一个新用户，否则不做任何操作输出要求：给出本函数的输出参数的详细说明。它主要包括它的输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系。返回要求：说明返回值的含义。3.3.2CAddUser3.3.2.1描述要求：简述此类下列相关内容：实现功能在模块中起到的作用引用此类应注意的事项。3.3.2.2引用包列表或头文件要求：简述此类下列相关内容：例如：java.util.Vectorcom.ztenc.xxx。3.3.2.3继承（实现）关系要求：继承（实现）的类（接口）的包的完整路径。例如：java.util.Vector3.3.2.4属性要求：描述属性名称、含义、数据