Doxygen使用教程个人总结VIP专享

精品文档---下载后可任意编辑一．什么是 Doxygen?Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。通常我们在写程序时，或多或少都会写上批注，但是对于其它人而言，要直接探究程序里的批注，与打捞铁达尼号同样的辛苦。大部分有用的批注都是属于针对函式，类别等等的说明。所以，假如能依据程序本身的结构，将批注经过处理重新整理成为一个纯粹的参考手册，对于后面利用您的程序代码的人而言将会减少许多的负担。不过，反过来说，整理文件的工作对于您来说，就是沉重的负担。Doxygen 就是在您写批注时，略微根据一些它所制订的规则。接着，他就可以帮您产生出美丽的文档了。因此，Doxygen 的使用可分为两大部分。首先是特定格式的批注撰写，第二便是利用 Doxygen的工具来产生文档。目前 Doxygen 可处理的程序语言包含：C/C++JavaIDL (Corba, Microsoft 及 KDE-DCOP 类型) 而可产生出来的文档格式有：HTMLXMLLaTeXRTFUnix Man Page而其中还可衍生出不少其它格式。HTML 可以打包成 CHM 格式，而 LaTeX 可以透过一些工具产生出 PS 或是 PDF 文档。二．安装 Doxygen1.1 安装 Doxygen 1.7.4(Windows) 1.2 安装 graphviz 2.28.0(Windows)graphviz 是一个由 AT&T 实验室启动的开源工具包，用于绘制 DOT 语言脚本描述的图形。Doxygen 使用 graphviz 自动生成类之间和文件之间的调用关系图，如不需要此功能可不安装该工具包。Doxygen 使用这个工具可以生成 CHM 格式的文档。三．Doxygen 的配置Doxygen 产生文档可以分为三个步骤。一是在程序代码中加上符合 Doxygen 所定义批注格式。二是使用 Doxywizard 进行配置。三是使用 Doxygen 来产生批注文档。Doxygen 1.7.4 主界面如下图 1 所示。 说明：1，Doxygen 工作目录，就是用来存放配置文件的目录。 2，递归搜索源文件目录需要选上。选择 wizard 标签下的 Output Topics相关配置说明如下图 2 所示。 选择 wizard 标签下的 Diagrams Topics相关配置说明如下图 3 所示。精品文档---下载后可任意编辑说明：假如选择这个选项之前需要先安装了 Graphviz 工具包。选择 expert 标签下的 Project Topics相关配置说明如下图 4 所示。说明：编码格式，UTF-8 是首选。假如需要显示中文则选择 GB2313.TAB_SIZE 主要是帮助文件中代码的缩进尺寸，譬如@code 和@endcode 段中代码的...