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

《Doxygen使用教程(个人总结).doc》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、简介Doxygen一．什么是Doxygen?Doxygen是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。通常我们在写程序时，或多或少都会写上批注，但是对于其它人而言，要直接探索程序里的批注，与打捞铁达尼号同样的辛苦。大部分有用的批注都是属于针对函式，类别等等的说明。所以，如果能依据程序本身的结构，将批注经过处理重新整理成为一个纯粹的参考手册，对于后面利用您的程序代码的人而言将会减少许多的负担。不过，反过来说，整理文件的工作对于您来说，就是沉重的负担。Doxygen就是在您写批注

2、时，稍微按照一些它所制订的规则。接着，他就可以帮您产生出漂亮的文档了。因此，Doxygen的使用可分为两大部分。首先是特定格式的批注撰写，第二便是利用Doxygen的工具来产生文档。目前Doxygen可处理的程序语言包含：·C/C++·Java·IDL(Corba,Microsoft及KDE-DCOP类型)  而可产生出来的文档格式有：·HTML·XML·LaTeX·RTF·UnixManPage而其中还可衍生出不少其它格式。HTML可以打包成CHM格式，而LaTeX可以透过一些工具产生出PS或

3、是PDF文档。二．安装Doxygen·1.1安装Doxygen1.7.4(Windows)·1.2安装graphviz2.28.0(Windows)graphviz是一个由AT&T实验室启动的开源工具包，用于绘制DOT语言脚本描述的图形。Doxygen使用graphviz自动生成类之间和文件之间的调用关系图，如不需要此功能可不安装该工具包。·1.3安装WindowsHelpWorkshop1.32Doxygen使用这个工具可以生成CHM格式的文档。三．Doxygen的配置Doxygen产生文档可

4、以分为三个步骤。一是在程序代码中加上符合Doxygen所定义批注格式。二是使用Doxywizard进行配置。三是使用Doxygen来产生批注文档。Doxygen1.7.4主界面如下图1所示。 说明：1，Doxygen工作目录，就是用来存放配置文件的目录。2，递归搜索源文件目录需要选上。选择wizard标签下的OutputTopics相关配置说明如下图2所示。 选择wizard标签下的 DiagramsTopics相关配置说明如下图 3所示。说明：如果选择这个选项之前需要先安装了Graphviz工

5、具包。选择 expert标签下的 ProjectTopics相关配置说明如下图 4所示。说明：编码格式，UTF-8是首选。如果需要显示中文则选择GB2313.TAB_SIZE主要是帮助文件中代码的缩进尺寸，譬如@code和@endcode段中代码的排版，建议设置成4。OPTIMIZE_OUTPUT_FOR_C这个选项选择后，生成文档的一些描述性名称会发生变化，主要是符合C习惯。如果是纯C代码，建议选择。SUBGROUPING这个选项选择后，输出将会按类型分组。选择 expert标签下的 Buil

6、dBuild页面，这个页面是生成帮助信息中比较关键的配置页面：EXTRACT_ALL表示：输出所有的函数，但是private和static函数不属于其管制。EXTRACT_PRIVATE表示：输出private函数。EXTRACT_STATIC表示：输出static函数。同时还有几个EXTRACT，相应查看文档即可。HIDE_UNDOC_MEMBERS表示：那些没有使用doxygen格式描述的文档（函数或类等）就不显示了。当然，如果EXTRACT_ALL被启用，那么这个标志其实是被忽略的。INT

7、ERNAL_DOCS主要指：是否输出注解中的@internal部分。如果没有被启动，那么注解中所有的@internal部分都将在目标帮助中不可见。CASE_SENSE_NAMES表示：是否关注大小写名称，注意，如果开启了，那么所有的名称都将被小写。对于C/C++这种字母相关的语言来说，建议永远不要开启。HIDE_SCOPE_NAMES表示：域隐藏，建议永远不要开启。SHOW_INCLUDE_FILES表示：是否显示包含文件，如果开启，帮助中会专门生成一个页面，里面包含所有包含文件的列表。INLI

8、NE_INFO：如果开启，那么在帮助文档中，inline函数前面会有一个inline修饰词来标明。SORT_MEMBER_DOCS：如果开启，那么在帮助文档列表显示的时候，函数名称会排序，否则按照解释的顺序显示。GENERATE_TODOLIST：是否生成TODOLIST页面，如果开启，那么包含在@todo注解中的内容将会单独生成并显示在一个页面中，其他的GENERATE选项同。SHOW_USED_FILES：是否在函数或类等的帮助中，最下面显示函数或类的来源文件。SHOW_FILES：是否显示