论文部分内容阅读
摘要:将源码文档生成工具Doxygen引入嵌入式操作系统教学,将函数调用关系,文件引用关系以及结构体定义等抽象内容图形化,以超链接的方式展现给学生,极大的提高了同学们的学习效率,取得了较好的教学效果。
关键词:Doxygen;uC/OS;嵌入式操作系统;教学
一、引言
嵌入式操作系统是我校电子信息工程专业本科生的专业必修课程。课程通过对uC/OS系统源码的讲解,使学生了解操作系统的基本概念,掌握uC/OS系统的任务管理、中断和时间管理、事件管理、消息管理等技术,为学生运用嵌入式操作系统知识进行后续的学习和工作打下较为坚实的基础。同学们大都是第一次阅读系统源码,uC/OS上万行的源码,其结构体、函数的定义、引用关系非常复杂,为了帮助同学们跨越源码阅读的障碍,我们将Doxygen工具引入教学,取得了较好的效果。
二、Doxygen工具简介
Doxygen是一个开源的源码文档生成工具,支持的开发语言非常广泛,有C++ , C, Objective-C, C#, PHP, Java, Python, IDL , Fortran, VHDL, Tcl等,生成的文档形式也多种多样,有HTML,PDF,RTF (MS-Word), PostScript, 以及 Unix man pages等。
三、Doxygen工具在嵌入式操作系统课程中的应用
1、图形化超链接展现uC/OS系统结构体的定义
在教学中发现,同学们首次接触uC/OS系统源码,最头疼的就是复杂的结构体定义,可以说,结构体定义是同学们读懂源码必须啃下的第一块硬骨头。通过Doxygen工具,可以将系统中所有结构体进行索引,如图1所示。同学们可以经常查看其定义代码。单击某一结构体,还可以进一步查看该结构体与其他结构体的引用关系,以及该结构体的成员变量,如图2所示。
2、图形化超链接展现uC/OS系统函数之间的调用关系
uC/OS系统文件之间的函数调用关系也比较复杂,是同学们学习本课程的另外一大難题。通过Doxygen工具,可以生成函数调用关系图,非常方便同学们从整体上把握函数之间的调用关系,如图3所示为任务返回函数的调用关系图。
3、图形化超链接展现uC/OS系统变量定义和引用的文件
uC/OS中变量在某一文件中定义,在其他多个文件中引用,也给同学们学习造成困扰,通过Doxygen工具,可以图形化超链接方式展示变量的定义和引用文件,给同学们学习提供了很大的便利,为节省篇幅,此处省略附图。
4、图形化展现uC/OS系统文件之间的引用关系
uC/OS系统源代码文件之间的引用关系也是同学们学习中难以把握的地方,通过Doxygen工具,可以生成文件应用关系图,如图4所示是ucos_ii.c文件的引用关系,通过图形化展示,同学们可以很轻松的进行把握。
四、结论
如上所述,引入Doxygen工具,可以将操作系统源码中的各种抽象的引用关系、调用关系以及复杂的定义图形化,并通过超链接的形式,极大的便利了源码阅读和学习过程,取得了较好的教学效果。
参考文献:
[1]宫晓利,徐浩聪,张金等.操作系统与嵌入式系统实验教学的融合探索[J],计算机教育;2017(4),125-128
作者简介:吉向东,男,山西临汾人,1972.5--,湖北文理学院,高级工程师。系统分析师,信息系统项目管理师,软件评测师。研究方向:软件工程,人工智能。
关键词:Doxygen;uC/OS;嵌入式操作系统;教学
一、引言
嵌入式操作系统是我校电子信息工程专业本科生的专业必修课程。课程通过对uC/OS系统源码的讲解,使学生了解操作系统的基本概念,掌握uC/OS系统的任务管理、中断和时间管理、事件管理、消息管理等技术,为学生运用嵌入式操作系统知识进行后续的学习和工作打下较为坚实的基础。同学们大都是第一次阅读系统源码,uC/OS上万行的源码,其结构体、函数的定义、引用关系非常复杂,为了帮助同学们跨越源码阅读的障碍,我们将Doxygen工具引入教学,取得了较好的效果。
二、Doxygen工具简介
Doxygen是一个开源的源码文档生成工具,支持的开发语言非常广泛,有C++ , C, Objective-C, C#, PHP, Java, Python, IDL , Fortran, VHDL, Tcl等,生成的文档形式也多种多样,有HTML,PDF,RTF (MS-Word), PostScript, 以及 Unix man pages等。
三、Doxygen工具在嵌入式操作系统课程中的应用
1、图形化超链接展现uC/OS系统结构体的定义
在教学中发现,同学们首次接触uC/OS系统源码,最头疼的就是复杂的结构体定义,可以说,结构体定义是同学们读懂源码必须啃下的第一块硬骨头。通过Doxygen工具,可以将系统中所有结构体进行索引,如图1所示。同学们可以经常查看其定义代码。单击某一结构体,还可以进一步查看该结构体与其他结构体的引用关系,以及该结构体的成员变量,如图2所示。
2、图形化超链接展现uC/OS系统函数之间的调用关系
uC/OS系统文件之间的函数调用关系也比较复杂,是同学们学习本课程的另外一大難题。通过Doxygen工具,可以生成函数调用关系图,非常方便同学们从整体上把握函数之间的调用关系,如图3所示为任务返回函数的调用关系图。
3、图形化超链接展现uC/OS系统变量定义和引用的文件
uC/OS中变量在某一文件中定义,在其他多个文件中引用,也给同学们学习造成困扰,通过Doxygen工具,可以图形化超链接方式展示变量的定义和引用文件,给同学们学习提供了很大的便利,为节省篇幅,此处省略附图。
4、图形化展现uC/OS系统文件之间的引用关系
uC/OS系统源代码文件之间的引用关系也是同学们学习中难以把握的地方,通过Doxygen工具,可以生成文件应用关系图,如图4所示是ucos_ii.c文件的引用关系,通过图形化展示,同学们可以很轻松的进行把握。
四、结论
如上所述,引入Doxygen工具,可以将操作系统源码中的各种抽象的引用关系、调用关系以及复杂的定义图形化,并通过超链接的形式,极大的便利了源码阅读和学习过程,取得了较好的教学效果。
参考文献:
[1]宫晓利,徐浩聪,张金等.操作系统与嵌入式系统实验教学的融合探索[J],计算机教育;2017(4),125-128
作者简介:吉向东,男,山西临汾人,1972.5--,湖北文理学院,高级工程师。系统分析师,信息系统项目管理师,软件评测师。研究方向:软件工程,人工智能。