doxygen

2009/10/17 写代码

DOXYGEN使用步骤

  • 第一次使用需要安装doxygen的程序
  • 生成doxygen配置文件
  • 编码时,按照某种格式编写注释
  • 生成对应文档

Doxygen

在生成文档时可以定义项目属性以及文档生成过程中的很多选项,使用下面命令能够产生一个缺省的配置文件:

doxygen -g [配置文件名]

可以根据项目的具体需求修改配置文件中对应的项。修改过的配置文件可以作为以后项目的模板。让doxygen自动产生文档,需要遵循doxygen自己的格式。

运行下面的命令,相应的文档就会产生在指定的目录中。

doxygen [配置文件名] 需要注意的是doxygen并不处理所有的注释,doxygen重点关注与程序结构有关的注释,比如:文件、类、结构、函数、变量、宏等注释,而忽略函数内变量、代码等的注释。

DOXYGEN配置文件

doxygen配置文件的格式是也是通常的unix下配置文件的格式:注释’#’开始;tag = value [,value2…];对于多值的情况可以使用 tag += value [,value2…]。

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

Search

    Table of Contents