需求
- 在一个项目里,不是每一块功能或代码块都是由一个人从头到尾去书写的;
- 也不是每个项目组都有完整的项目规范的,我就经历过一次了;
- 庞大的代码量,没有注释的代码块;
解决方案
使用doxygen和graphviz来自动分析函数间的调用关系
工具介绍
- doxygen
- graphviz
工具安装
doxygen
我是从官网上直接下载的安装文件,所以我直接安装就可以使用,如果你下载的是其他的,那可以自行看一下官方的安装或编译文档。
graphviz
安装的时候直接next就行了,无须注意什么!
如何生成
- 打开doxygen
1:设定Doxygen的运行目录 2:设定生成工程的工程名称 3:设定目标代码的根目录 4:开启递归遍历 5:Doxygen的生成文件存放的目录
1:勾选所有实体 2:勾选包含跨引用输出 3:选中Doxygen需要遍历的代码语言
1:勾选压缩html的准备
1:开启graphviz 2:开启函数调用图
如果生成的文档希望是中文的话,就在这里选择一下语言
选中graphviz安装目录下的
bin
目录到这里就只有等待其生成完成了!
结果
补充
每次生成都需要配置那么多的话,相信不少人早就想放弃了,那么现在我补充一下如何快速用命令行生成; 这里我取了一下巧,纯命令大神勿喷!
- 通过之前的那几步,我们能导出一份完整的文档了
File/save
、Ctrl+s
直接保存当前配置~我们就命名为Config1
- 打开
cmd
- 键入
doxygen
+Config1
后执行 - 完工!
PREVIOUS如何生成C#版的protobuf