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

简Doxygen 一．什么是Doxygen? Doxygen 是一个程产可将转换为说我们写程时会写对捞铁达尼号样属于针对函类别说结将批注经过处为个纯参考手册对代码将会减少许负担过过来说对来说负担Doxygen 就是在您写批注时订规则着帮产Doxygen 的使用可分为两写Doxygen的工具来产目前Doxygen可处语 C/C++ Java IDL (Corba, Microsoft及KDE-DCOP类)?? 而可产来 HTML XML LaTeX RTF Unix Man Page 而其中还LaTeX可以透过产PS或是PDF文档。 二．安装Doxygen 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 所示。 ?说明：Doxygen 工作目录就是用来存放配置文件的目录。选择 wizard 标签下的 Output Topics 相关配置说明如下图 2 所示。 ?选择 wizard 标签下的?Diagrams Topics 相关配置说明如下图?3 所示。 之前安装了 Graphviz 工具包。选择?expert 标签下的?Project Topics 相关配置说明如下图?4 所示。 说明：编码格式，UTF-8 是首选。选择?expert 标签下的? 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 所示。 ? 说明：如果在 Wizard 的 Output Topics 中选择了 prepare for compressed HTML (.chm)选项，此处就会要求选择 hhc.exe 程序的位置。在 windows help workshop 安装目录下可以找到 hhc.exe。选择?Run 标签 相关配置说明如下图?7 所示。 ? ?点击 Run doxygen 按钮， Doxygen 就会从源代码中抓取符合规范的注释生成你定制的格式的文档。 写正 并非所有程序代码会被Doxy