文章目录
- 工具简介和安装
- Doxygen
- Graphziv
- 软件安装
- 工具的运用
- 启动和配置
- 工具分析结果
工具简介和安装
Doxygen
Doxygen 是一种用于从 C 、C++ 、Objective-C 、C# 、Java 和 Python 等语言的源代码中生成文档的工具。它通过解析源代码中的注释来创建详细的 API 文档，包括类、函数、变量和模块的描述。
Doxygen 支持多种输出格式，如 HTML 、LaTeX 、RTF 和 XML，其主要的特点如下：
-
支持多种编程语言：Doxygen 可以从多种编程语言的源代码中提取注释并生成文档；
-
自动生成目录：Doxygen 可以根据源代码中的结构自动生成目录，方便用户查找和浏览文档；
-
支持多种注释风格：Doxygen可以识别并处理多种注释风格，如 Javadoc 、Qt 和 Doxygen 风格的注释；
-
支持图表和示例代码：Doxygen 可以从源代码中提取类图、继承关系图和协作图，并在文档中展示；
-
可定制性强：Doxygen 提供了许多配置选项，用户可以根据需要定制输出的文档样式和内容。
-
支持多语言：Doxygen 支持将文档翻译成多种语言，方便不同语言的用户阅读。
Graphziv
Graphviz（Graph Visualization Software）是一个开源的图形可视化软件，用于绘制 DOT 语言脚本描述的图形。它主要用于生成结构化信息的图形表示，如流程图、组织结构图、网络拓扑图等。
Graphviz 具有高度的可扩展性和灵活性，支持多种输出格式，如 PDF 、PNG 、SVG 和 HTML 等，其主要的组件如下：
-
DOT ：一种描述图形的语言，用于定义节点、边和属性等图形元素；
-
dot ：一个命令行工具，用于将 DOT 脚本转换为 PDF 、PNG 等格式；
-
Graphviz 库：一组用于创建、解析和渲染 DOT 脚本的 API ，支持 C、 Python 等多种编程语言。
软件安装
- 在线方式
（1）Linux 操作系统中可以在终端中安装 Doxygen 和 Graphziv 软件，依次执行以下命令：
apt install doxygen doxygen-gui
apt install graphviz
- 离线方式
（2）在 Doxygen 和 Graphziv 官网中下载对应版本的软件，安装方法参考官网即可，如下图所示。
- Doxygen
- Graphviz
（3）安装成功后，在终端执行以下命令查看软件版本信息，如下图所示。
doxygen -V
dot -V
工具的运用
启动和配置
（1）Doxywizard 是配置和运行 Doxygen 的 GUI 前端，可以快捷地创建配置文件，在终端中执行以下命令启动该程序。
doxywizard
（2）设置 Step1 和 Step2 中的 ”Wizard“ 选项卡，如下图所示。
-
在 Step1 中选择 Doxygen 的工作目录；
-
设置 Doxygen 的项目名称；
-
选择待分析的程序源代码文件或目录，可以是单个源码文件或源码目录；
-
选择 Scan recursively ，递归分析源代码目录中的子目录内的源代码；
-
设置生成文档的输出路径。
（3）设置 “Wizard” 选项卡的其它 topics ，如下图所示。
- 在 “Mode” 中设置指定语言
- 在 “Output” 中设置输出文档类型
- 在 “Diagrams” 中选择生成图类型
（4）设置 “Expert” 选项卡，如下图所示。
- 取消勾选 FULL_PATH_NAMES
- 在 “Build” 中设置 EXTPACT
- 在 “Input” 中排除文件或目录
- 在 “Dot” 中配置 Graphviz 的安装路径（Linux 默认路径为
/usr/bin）
（5）在 “Run” 选择卡中点击 “Run doxygen” 开始分析源代码，完成后点击 “show HTML output” 会自动打开生成的文档网页，如下图所示。
工具分析结果
以 Linux 操作系统的 linux-0.11 内核源代码为例，展示 Doxygen 和 Graphviz 软件分析源码的部分结果，如下图所示。
- 源码目录
- mian.c
- task_struct 结构体
- 结构体索引
参考链接：
- Doxygen 官网
- Graphviz 官网
