ZC4001软件详细设计.docx
《ZC4001软件详细设计.docx》由会员分享，可在线阅读，更多相关《ZC4001软件详细设计.docx（9页珍藏版）》请在冰豆网上搜索。
ZC4001软件详细设计
软件详细设计
产品名称（中文）
产品名称（英文）
产品型号
产品版本
模块名称
文档作者
文档版本
修订记录
修订时间
修订内容
修订者
目录
1概述4
1.1软件概述4
1.2定义4
1.3参考文献4
2功能描述4
2.1软件外部功能说明4
2.2软件功能框图4
3数据结构5
3.1常量定义5
3.2结构定义5
3.3类定义5
3.4变量定义5
4程序流程5
4.1主程序A15
4.1.1函数原型5
4.1.2功能6
4.1.3入口参数6
4.1.4出口参数6
4.1.5局部变量6
4.1.6函数调用6
4.1.7流程图6
4.2主程序A26
4.2.1函数原型7
4.2.2功能7
4.2.3入口参数7
4.2.4出口参数7
4.2.5局部变量7
4.2.6函数调用7
4.2.7流程图7
4.3子程序B18
4.3.1函数原型8
4.3.2功能8
4.3.3入口参数8
4.3.4出口参数8
4.3.5局部变量8
4.3.6函数调用8
4.3.7流程图8
4.4子程序B29
4.4.1函数原型9
4.4.2功能9
4.4.3入口参数9
4.4.4出口参数9
4.4.5局部变量9
4.4.6函数调用9
4.4.7流程图9
4.5中断服务程序C110
4.5.1中断类型10
4.5.2中断等级10
4.5.3功能10
4.5.4入口参数10
4.5.5出口参数10
4.5.6局部变量10
4.5.7函数调用10
4.5.8流程图11
4.6中断服务程序C211
4.6.1中断类型11
4.6.2中断等级11
4.6.3功能11
4.6.4入口参数11
4.6.5出口参数11
4.6.6局部变量11
4.6.7函数调用12
4.6.8流程图12
5源文件列表12
6其它12
1概述
1.1软件概述
简要说明该软件的名称，在整个产品中的位置、作用。
1.2定义
定义所有必要的术语，以便读者可以正确地理解本文档，包括词头和缩写。
1.3参考文献
列出所有参考文献名称、作者、标题、编号、发布日期和出版单位等基本信息。
2功能描述
2.1软件外部功能说明
根据该软件在系统中的位置和作用详细说明该软件要完成的外部功能。
2.2软件功能框图
根据以上外部功能，采用图形方式详细说明该软件采用何种功能结构完成这些外部功能。
3数据结构
3.1常量定义
说明常量或常数表的含义，并说明这些常量取当前值的原因。
3.2结构定义
定义全局结构体的含义。
3.3类定义
说明类的定义及其继承关系。
3.4变量定义
定义全局变量的含义。
4程序流程
4.1主程序A1
主程序除包括如C语言中的main（）函数外，还应包括被main（）调用的主调度函数，主调度函数一般是一个永远不会退出的死循环函数。
4.1.1函数原型
给出被说明函数的原型。
4.1.2功能
说明主函数的功能，除系统需求中要求的功能外还要说明主函数在系统调度中所起的作用。
4.1.3入口参数
主程序的入口参数有两种，第一种入口参数通常在软件启动运行以前确定，这些参数可以表现为任何可能的形式（上电检测跳线、EEPROM数据等），由主程序收集形成。
第二种入口参数由软件的其他部分在运行中产生，通常代表软件当前的运行状态、运行结果或外部输入信息等。
这两种入口参数都可以决定主程序以什么样的方式工作。
请对所有主程序的入口参数进行说明。
4.1.4出口参数
主程序的出口参数指主程序对其入口参数进行处理后产生的信息。
应说明这些出口参数与上述入口参数的关系。
4.1.5局部变量
说明仅在主程序范围内有效的局部变量包括哪些，这些变量应该在前面已经定义过。
4.1.6函数调用
说明主程序为了完成其功能必须调用哪些函数或子程序。
4.1.7流程图
画出主程序的流程图并用文字说明之。
4.2主程序A2
主程序除包括如C语言中的main（）函数外，还应包括被main（）调用的主调度函数，主调度函数一般是一个永远不会退出的死循环函数。
4.2.1函数原型
给出被说明函数的原型。
4.2.2功能
说明主函数的功能，除系统需求中要求的功能外还要说明主函数在系统调度中所起的作用。
4.2.3入口参数
主程序的入口参数有两种，第一种入口参数通常在软件启动运行以前确定，这些参数可以表现为任何可能的形式（上电检测跳线、EEPROM数据等），由主程序收集形成。
第二种入口参数由软件的其他部分在运行中产生，通常代表软件当前的运行状态、运行结果或外部输入信息等。
这两种入口参数都可以决定主程序以什么样的方式工作。
请对所有主程序的入口参数进行说明。
4.2.4出口参数
主程序的出口参数指主程序对其入口参数进行处理后产生的信息。
应说明这些出口参数与上述入口参数的关系。
4.2.5局部变量
说明仅在主程序范围内有效的局部变量包括哪些，这些变量应该在前面已经定义过。
4.2.6函数调用
说明主程序为了完成其功能必须调用哪些函数或子程序。
4.2.7流程图
画出主程序的流程图并用文字说明之。
4.3子程序B1
4.3.1函数原型
给出被说明子程序的函数原型。
4.3.2功能
说明子程序完成的功能。
4.3.3入口参数
子程序的入口参数包括所有影响其输出的信息，而不仅仅是调用参量。
4.3.4出口参数
子程序的出口参数也不仅仅是其返回值，而包括所有受该子程序影响并有可能因此改变的所有信息。
4.3.5局部变量
说明仅在本程序内有效的所有局部变量。
4.3.6函数调用
说明本程序所调用的所有函数或子程序。
4.3.7流程图
画出程序流程图并给出说明。
4.4子程序B2
4.4.1函数原型
给出被说明子程序的函数原型。
4.4.2功能
说明子程序完成的功能。
4.4.3入口参数
子程序的入口参数包括所有影响其输出的信息，而不仅仅是调用参量。
4.4.4出口参数
子程序的出口参数也不仅仅是其返回值，而包括所有受该子程序影响并有可能因此改变的所有信息。
4.4.5局部变量
说明仅在本程序内有效的所有局部变量。
4.4.6函数调用
说明本程序所调用的所有函数或子程序。
4.4.7流程图
画出程序流程图并给出说明。
4.5中断服务程序C1
4.5.1中断类型
说明中断类型，如定时器中断、外部中断等。
4.5.2中断等级
说明中断优先等级，并说明该等级在中断系统中的优先位置。
4.5.3功能
说明本中断服务程序完成的功能。
4.5.4入口参数
入口参数包括所有影响其运行结果的信息。
4.5.5出口参数
出口参数包括所有受本中断服务程序影响的信息。
4.5.6局部变量
说明所有在本函数内有效的局部变量。
4.5.7函数调用
说明所有被本程序调用的所有函数或子程序。
4.5.8流程图
画出流程图并说明。
4.6中断服务程序C2
4.6.1中断类型
说明中断类型，如定时器中断、外部中断等。
4.6.2中断等级
说明中断优先等级，并说明该等级在中断系统中的优先位置。
4.6.3功能
说明本中断服务程序完成的功能。
4.6.4入口参数
入口参数包括所有影响其运行结果的信息。
4.6.5出口参数
出口参数包括所有受本中断服务程序影响的信息。
4.6.6局部变量
说明所有在本函数内有效的局部变量。
4.6.7函数调用
说明所有被本程序调用的所有函数或子程序。
4.6.8流程图
画出流程图并说明。
5源文件列表
列出所有的源程序文件名并分别说明用途。
6其它
其它详细设计要点。
升级会员 