Doxygen是一款强大的文档生成工具，能将程序注释转换为API文档，支持C/C++、Java等多种语言，输出HTML、XML等格式。本文介绍Doxygen的安装与使用，包括配合Graphviz生成函数调用图。
简介
Doxygen是一个程序的文档产生工具，可以将程序中的注释转换成说明文档或者说是API参考手册，从而减少程序员整理文档的时间。当然这里程序中的注释需要遵循一定的规则书写，才能让Doxygen识别和转化。
目前Doxygen可处理的程序语言包含C/C++、Java、Objective-C、IDL等，可产生出来的文档格式有HTML、XML、LaTeX、RTF等，此外还可衍生出不少其它格式；
如 HTML可以打包成CHM格式，而LaTeX可以通过一些工具产生出PS或是PDF文档等。
如 可以利用Doxygen给C，C++程序生成注释文档
Doxygen安装及使用
1）推荐版本--安装列表：（windows）
Doxygen： 下载地址，http://doxygen.nl/files/doxygen-1.8.15-setup.exe
HTML Help：微软官方用于生成HTML格式的help文件，下载地址，http://go.microsoft.com/fwlink/p/?linkid=14188
Graphviz：一种dot工具可以用来渲染出效果更好的图表，下载地址，https://graphviz.gitlab.io/_pages/Download/Download_windows.html
windows上安装很简单，无需特别设置。
2）其他版本：（根据系统选择）
Doxygen可以从一套源文件开始，生成HTML格式的在线类浏览器。建议采用的版本是Doxygen1.8.16（目前最新，以后会替换）
Microsoft HTML Help Workshop是微软开发，用于本工程创建*.chm文件，建议上官网下载最新的htmlhelp
Graphviz用于配合doxygen使用，提取函数之间、头文件之间的调用关系，建议上官网下载最新的graphviz
说明：
下载Doxygen + Graphviz
Doxygen可以生成动态文档
Graphviz可以生成视图连接将.c文件中所用到的函数、头文件生成一个树状结构并且设置之后可以生成相对应的函数的跳转，方便查询函数。
安装步骤
1）安装 graphviz （dot, 结构图关系图用到）
2）安装Windows Help Workshop（生成 .chm用到）
3）安装doxygen
例如：安装Windows Help Workshop
安装完成后，打开Doxygen
打开如下界面：
恭喜你成功安装Doxygen
希望对你有帮助。
扫一扫
1298
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
