文 献 综 述

一、文档自动生成问题

随着软件进入人类社会以来，软件产品的需求一直处于增长的状态。面对如此大的软件需求，如何提高软件的生产效率，降低软件开发的周期与成本，便成为软件产业界所关注的焦点。各种编程语言的大量编写过程中，一个好的程序设计师，都会在适当的地方加上合适的批注。如果能够在撰写批注时，稍微符合某种格式，接着就可以透过一个工具程序依据程序结构及批注而产生文件，这使许多工作繁重的编译得到了适当的解放。Doxygen 就是这样的一个工具。Doxygen的主要功能是分析和抽取按照特定标记格式书写的代码注释，生成多种格式的项目文档，正是如此软件的应用，大大提高了生产效率。

二、相关软件#8212;Doxygen简介

Doxygen的词根来源于Document（文档）和Oxygen（氧气），它是一个功能强大、使用方便且支持各种操作系统和编程语言的代码文档生成系统。Doxygen由荷兰人Dimitri van Heesch.开发，并且在GNU公共许可证（GPL）下发布，目前已经成为各主要的Linux发行版的附带组件。众多重量级的软件项目（如KDE，Qt、ACE库等）都选用Doxygen作为其编档工具生成项目文档。可处理的程序语言包括C/C 、Java、Objective-C 、Python、Fortran等，可产生的文件格式有以网站形式组织的HTML、 PostScript、LaTex、XML、 Unix Man Page Rich Text Format（RTF）。

Doxygen的使用步骤非常简单。主要可以分为：1）第一次使用需要安装doxygen的程序2）生成doxygen配置文件3）编码时，按照某种格式编写注释 4）生成对应文档

Doxygen在生成文档时可以定义项目属性以及文档生成过程中的很多选项，使用下面命令能够产生一个缺省的配置文件：
doxygen -g [配置文件名]
可以根据项目的具体需求修改配置文件中对应的项，具体的修改过程在下面介绍。修改过的配置文件可以作为以后项目的模板。

Doxygen配置文件的格式是也是通常的unix下配置文件的格式：注释'#'开始；tag = value [,value2#8230;]；对于多值的情况可以使用 tag = value [,value2#8230;]。

对doxygen的配置文件的修改分为两类：一种就是输出选项，控制如何解释源代码、如何输出；一种就是项目相关的信息，比如项目名称、源代码目录、输出文档目录等。对于第一种设置好后，通常所有项目可以共用一份配置，而后一种是每个项目必须设置的。下面选择重要的，有可能需要修改的选项进行解释说明，其他选项在配置文件都有详细解释。

Doxygen常用注释格式。对函数的注释，是比较常常需要注释的部分。除了定义其简要说明以及详细注释，还可以使用param命令对其各个参数进行注释，使用return命令对返回值进行注释。常见的格式如下：
/**
*@brief func's brief comment.
*
* Some detailed comment.
*@param a [param a 's comment.]
*@param b [param b 's comment.]
*@exception std::out_of_range [exception's comment.]
*@return [return's comment.]
*/
int func1(int a, int b);