简介Doxygen
一．什么是Doxygen？
Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。通常我们在写程序时，或多或少都会写上批注，但是对于其它人而言，要直接探索程序里的批注,与打捞铁达尼号同样100篇名家经典散文摘抄的辛苦.大部分有用的批注都是属于针对函式,类别等等的说明。所以，如果能依据程序本身的结站长圈构，将批注经过处理重新整理成为一个纯粹的参考手册，接受近义词对于后面利用您的程序代码的人而言将会减少许多的负担.不过,反过来说，整理文件的工作对于您来说，就是沉重的负担。
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 自动生成类之间和文件之间的调用关系图，如不需要此功能可不安装该工具包。
∙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修饰词来标明.
SORT_MEMBER_DOCS ：如果开启，那么在帮助文档列表显示的时候，函数名称会排序，否则按照解释的顺序显
示。
GENERATE_TODOLIST ：是否生成TODOLIST页面,如果开启，那么包含在@todo注解中的内容将会单独生成并显
示在一个页面中，其他的GENERATE选项同.批量处理图片
SHOW_USED_FILES ：是否在函数或类等的帮助中，最下面显示函数或类的来源文件。
SHOW_FILES ：是否显示文件列表页面,如果开启，那么帮助中会存在一个一个文件列表索引页面。
选择 expert 标签下的 Input Topics
相关配置说明如下图 5 所示。
说明：输入的源文件的编码,要与源文件的编码格式相同。如果源文件不是UTF-8编码最好转一下。
选择 expert 标签下的 HTML Topics
相关配置说明如下图 6 所示。
说明：1，CHM_FILE文件名需要加上后缀(xx。chm）.
2，如果在 Wizard 的 Output Topics 中选择了 prepare for compresd HTML (.chm）选项，此处就会要求选择 程序的位置.在 windows help workshop 安装目录下可以找到 hhc。exe.
