南昌研究所软件模块详细设计说明模板(面向对象)

《南昌研究所软件模块详细设计说明模板(面向对象)》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、技术文件技术文件名称：软件模块详细设计说明技术文件编号：版本：拟制审核会签标准化批准中兴软件南昌研究所<模板使用说明：（1）模板内容供参考，可以根据实际情况删除或增加二级和三级标题要求的内容，但不能删除一级标题。（2）对于模板中涉及数据的分析和统计，建议使用表格和图形表示，使数据更清晰直观。（3）在编辑完整个文档后，点击鼠标右键，选择“更新域——更新整个目录”即可。（4）在页眉右上角的密级表示的此类文档最低的密级，具体产品可以根据实际情况确定为更高的密级，如模板要求为“机密▲”，可以根据产品的重要程度可以上升为“绝密▲”。（5）其中包括用尖括号括起来并以蓝色斜

2、体显示的文本，它们用于向作者提供指导，在发布此文档之前应该将其删除。修改记录文件编号版本号拟制人/修改人拟制/修改日期更改理由主要更改内容（写要点即可）钟伦甫2006-4-27建立文档注：文件第一次拟制时，“更改理由”、“主要更改内容”栏写“无”。>6修改记录文件编号版本号拟制人/修改人拟制/修改日期更改理由主要更改内容（写要点即可）注：文件第一次拟制时，“更改理由”、“主要更改内容”栏写“无”。61编写目的52术语、定义和缩略语52.1术语、定义52.2缩略语53模块描述54标准模块55模块设计56数据描述56.1数据结构说明56.2全局变量说明56.3数据库说明57

3、函数定义57.1引用函数定义57.2内部函数定义57.2.1内部函数167.2.2内部函数267.2.3内部函数n68接口设计68.1用户接口68.2硬件接口68.3软件接口68.3.1规范接口68.3.2非规范接口69其它说明610参考资料661编写目的<要求：说明编写本文件的目的在于详细地说明××××模块中各成分的设计考虑，以利于程序员编制程序。>2术语、定义和缩略语2.1术语、定义<要求：逐项列出本文中用到的难以理解或可能引起混淆的术语及其定义。>2.2缩略语本文件应用了以下缩略语：<要求：逐项列出本文中用到的缩略语及其原文和汉语含义。>3模块描述<要求：从模块在

4、系统中的位置，实现原理及方式、实现的主要功能等方面来描述该模块的概貌。>4标准模块<要求：说明在产品模块库、事业部模块库中对标准模块查询结果、指出引用的标准模块的内容和应用方式、描述本模块中可能抽象的公用模块及其应用范围>5模块设计<要求：主要用文字、图表等形式详细描述该模块的状态迁移、信号流程、程序流程、界面安排、进程关系、异常处理、错误处理等方面。详细说明本模块中的可测试性设计，包括提供的测试接口，测试内容和范围等。>6类定义6.1类一6.1.1描述<要求：简述此类下列相关内容：l实现功能l在模块中起到的作用l引用此类应注意的事项。>6.1.2引用包列表<要求：简述

5、此类下列相关内容：例如：java.util.Vectorcom.ztenc.xxx。>6.1.3继承（实现）关系<要求：继承（实现）的类（接口）的包的完整路径。例如：java.util.Vector>61.1.1属性<要求：描述属性名称、含义、数据类型、访问类型、修饰符以及初始值。>1.1.1.1<属性一>l含义<例如：用户名。>l数据类型<例如：java.lang.String。>l访问类型<例如：private。>l修饰符<例如：无。>l初始值<例如：null。>1.1.2方法1.1.2.1<方法一>l功能描述l访问类型<例如：private。>l修饰符<例如：st

6、atic。>l输入<要求：给出本函数的输入参数的详细说明,包括取值范围、含义，及参数间的控制、顺序、独立或依赖等关系。>l算法与处理流程<要求：说明本函数的关键实现方法与处理流程。明确对程序的注释。规定对信息是否有特殊的编码要求。>l输出<要求：给出本函数的输出参数的详细说明。它主要包括它的输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系。>l返回<要求：说明返回值的含义。>2单元定义<说明：此处定义项目中web页面（asp、jsp）或其它脚本语言的详细设计。单元是指一张页面或一个独立的文件中：l一段完整的代码（如jsp）；6l一个函数（如javascrip

7、t）。>1.1单元一1.1.1名称<例如：login.jsp。>1.1.2功能描述<例如：用户登录。>1.1.2.1输入<要求：给出本函数的输入参数的详细说明,包括取值范围、含义，及参数间的控制、顺序、独立或依赖等关系。如果是非函数（如jsp），则为无。>1.1.2.2算法与处理流程<要求：说明本函数的关键实现方法与处理流程。明确对程序的注释。规定对信息是否有特殊的编码要求。>1.1.2.3输出<要求：给出本函数的输出参数的详细说明。它主要包括它的输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系。如果是非函数（如jsp），则为