clang-uml 安装和配置指南

最新推荐文章于 2025-06-07 09:20:12 发布

刁嵘罡

最新推荐文章于 2025-06-07 09:20:12 发布

阅读量691

点赞数 3

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_07010/article/details/142231794

clang-uml 安装和配置指南

clang-uml Customizable automatic UML diagram generator for C++ based on Clang. 项目地址: https://gitcode.com/gh_mirrors/cl/clang-uml

1. 项目基础介绍和主要编程语言

项目基础介绍

clang-uml 是一个基于 Clang 的自动 UML 图生成器，专门用于生成 C++ 代码的类图、序列图、包图和包含图。它通过 YAML 配置文件来定义生成的图表类型和内容，旨在帮助开发者轻松维护和文档化代码库。

主要编程语言

该项目主要使用 C++ 编程语言，并且支持 C++ 标准库和部分 C++20 特性。

2. 项目使用的关键技术和框架

关键技术

Clang: 作为代码解析器，用于解析 C++ 代码并生成 UML 图。
YAML: 用于配置文件的格式，定义生成的图表类型和内容。
PlantUML: 支持生成 PlantUML 格式的图表。
MermaidJS: 支持生成 MermaidJS 格式的图表。
JSON: 支持生成 JSON 格式的图表。

框架

CMake: 用于构建和管理项目。
GitHub Actions: 用于持续集成和自动化测试。

3. 项目安装和配置的准备工作和详细的安装步骤

准备工作

在开始安装之前，请确保您的系统已经安装了以下工具和库：

CMake: 版本 3.14 或更高。
Clang: 版本 10 或更高。
Git: 用于克隆项目仓库。
Python: 用于运行一些辅助脚本。

安装步骤

步骤 1: 克隆项目仓库

首先，使用 Git 克隆 clang-uml 项目仓库到本地：

git clone https://github.com/bkryza/clang-uml.git
cd clang-uml

步骤 2: 生成构建文件

使用 CMake 生成构建文件。您可以选择使用 make 或 ninja 作为构建工具。以下是使用 make 的示例：

mkdir build
cd build
cmake ..

步骤 3: 编译项目

在生成的构建目录中，使用 make 编译项目：

make

步骤 4: 安装项目

编译完成后，您可以选择安装 clang-uml 到系统路径：

sudo make install

步骤 5: 配置 YAML 文件

在项目根目录下，您需要创建一个 YAML 配置文件（例如 clang-uml.yaml），用于定义生成的图表类型和内容。以下是一个简单的示例配置：

compilation_database_dir: .
output_directory: diagrams

diagrams:
  myproject_class:
    type: class
    glob:
      - src/*.cc
    using_namespace: myproject
    include:
      namespaces:
        - myproject
    exclude:
      namespaces:
        - myproject::detail
    plantuml:
      after:
        - 'note left of [[ alias("MyProjectMain") ]]: Main class of myproject library'