Doxygen使用教程(个人总结).docxVIP

简介 Doxygen 一．什么是 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 是一个由 ATT 实验室启动的开源工具包，用于绘制 DOT 语言 脚本描述的图形。Doxygen 使用 graphviz 自动生成类之间和文件之间的调 用关系图，如不需要此功能可不安装该工具包。 ?  1.3 安装 Windows Help Workshop 1.32 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 段中代码的排版，建议设置成 4。 OPTIMIZE_OUTPUT_FOR_C 这个选项选择后，生成文档的一些描述性名称会发生变化，主要是符合 C 习惯。如果 是纯 C 代码，建议选择。 SUBGROUPING 这个选项选择后，输出将会按类型分组。 选择 expert 标签下的 Build Build 页面，这个页面是生成帮助信息中比较关键的配置页面： EXTRACT_ALL 表示：输出所有的函数，但是 private 和 static 函数不属于其管制。 EXTRACT_PRIVATE 表示：输出 private 函数。 EXTRACT_STATIC 表示：输出 static 函数。同时还有几个 EXTRACT，相应查看文档即可。 HIDE_UNDOC_MEMBERS 表示：那些没有使用 doxygen 格式描述的文档（函数或类等）就不显示了。当然，如果 EXTRACT_ALL 被启用，那么这个标志其实是被忽略的。 INTERNAL_DOCS 主要指：是否输出注解中的@internal 部分。如果没有被启动，那么注解中所有的@internal 部分都 将在目标帮助中不可见。 CASE_SENSE_NAMES 表示：是否关注大小写名称，注意，如果开启了，那么所有的名称都将被小写。对于 C/C++这种 字母相关的语言来说，建议永远不要开启。 HIDE_SCOPE_NAMES 表示：域隐藏，建议永远不要开启。 SHOW_INCLUDE_FILES 表示：是否显示包含文件，如果开启，帮助中会专门生成一个页面，里面包含所有包含文件的列 表。 INLINE_INFO ：如果开启，那么在帮助文档中，inline 函数前面会有一个 inline 修饰词来标明。