利用Doxygen对程序进行自动生成说明文件方法的初探文献综述
2021-09-28 20:05:01
毕业论文课题相关文献综述
文献综述1、引言:通常我们在写程序时,或多或少都会写上批注(Comment),用以说明或记录程序中的一些要注意的事项,而其中大部分有用的批注都是属于针对函数、类型等等的说明。
编程语言是用来与计算机沟通的语言,而注释的作用则是与其他开发人员沟通,优秀、规范的注释对程序代码后续的编写、维护或者查阅有很大的用处。
然而,面对稍微大一点的程序的代码,即使是经验丰富的程序员也会有这样的疑问:这个函数是在哪里定义的?所以,如果能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对于后面利用我们的程序代码的人而言将会减少许多的负担。
不过,反过来说,整理文件的工作对于我们来说,就是沉重的负担。
因此,我们要寻找一种比较方便快捷高效的方法来将批注进行批量整理。
Javadoc和Doxygen就是程序用于此类文件的产生工具,可将程序中的特定批注转换成为说明文件,这样可以帮助我们自动产生程序的说明文件。
相比于Javadoc只适用于Java语言编写的程序, Doxygen是一种开源跨平台的文档系统,完全支持C、C 、Java、Objective-C和IDL语言,部分支持PHP、C#,并且注释的语法与Qt-Doc、KDoc和JavaDoc兼容。
Doxygen作为大名鼎鼎的文档生成工具,被Boost、OpenCasCade等诸多项目作为文档生成的不二人选,实际上,Doxygen 自己的使用手册就是使用Doxygen 产生的。
2、内容:利用Doxygen为源程序生成说明文档分为两种基本情况,一是按照约定的格式注释源代码,利用Doxygen处理注释过的源文件从而产生在线文档浏览器(HTML格式),以及离线参考手册(LATEX格式),同时还支持生成RTF(MS-Word)、Postscript、超链接PDF、压缩HTML和Unixman page格式的输出,因为文档是从源文件中直接提取的,保证了文档和源码的一致。
二是对于没有标注的源文件,可以通过配置Doxygen从中提取代码结构,这对于要在大量源文件中快速找到所需要的东西来说是非常有用的。
课题毕业论文、开题报告、任务书、外文翻译、程序设计、图纸设计等资料可联系客服协助查找。