-
win系统下,doxygen软件下载和安装
doxygen-1.8.14-setup.exe
协调使用的软件下载和配置:
graphviz-2.38.msi——生成调用关系图
htmlhelp.exe——生成chm文件(可选) -
打开软件
-
准备工作文件夹
1)新建文件夹,该文件夹包含:
①doxyfile——配置文件,附件:C/C++配置文件Doxyfile;
②project_code——源码文件夹,将需要生成的源代码文件拷贝至该文件夹下即可;
③DoxyOutput——输出文件夹,保存Doxygen生成的所有文件;
-
打开Doxygen软件,点击file —>open—>上一步所建文件夹中的Doxyfile配置文件(D:\Program Files (x86)\doxygen\2020-04-01\Doxyfile),此时Doxygen软件界面如下:
说明:配置文件在doxygen软件打开后,就自动生成了。你在界面中填写后,会自动修改,然后save as保存。
Mode中可修改语言类型,支持:C、C++、C#、Java等
其它详细配置参考:https://blog.csdn.net/weixin_42465158/article/details/114838506
-
附件的配置文件中,已经配置了HTML、DOT,用于生成调用关系图、chm文件,如下:
1)htmlhelp下载:http://msdn.microsoft.com/en-us/library/ms669985.aspx
Doxygen自动生成chm,需下载HTML Help Workshop,我们将要使用当中的hcc.exe文件以及相关dll。
2)Graphviz下载:http://www.graphviz.org/download/
graphviz 是一个由AT&T实验室启动的开源工具包,用于绘制DOT语言脚本描述的图形。Doxygen 使用 graphviz 自动生成类之间和文件之间的调用关系图,如不需要此功能可不安装该工具包。 -
代码注释
Doxygen 可以从源代码中提取消息生成帮助文档,它是根据源代码中的特定注释来实现。所以,首先要给工程代码书写符合Doxygen格式的注释。
见博客:《Doxygen简明注释语法》
《doxygen的文档生成,注释规范 》 -
linux安装及使用手册
详见百度文档:《doxygen配置及使用手册 》
注:*.chm 目录为乱码,应将下图 UTF-8改改为GB2312