clang-uml 使用教程

clang-uml 使用教程

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

项目介绍

clang-uml 是一个基于 Clang 的自动 C++ 到 UML 类、序列和包含图生成器，由 YAML 配置文件驱动。该项目的主要目的是在代码库中轻松维护最新的图表，或为遗留代码生成文档。clang-uml 支持生成 PlantUML、MermaidJS 和 JSON 格式的图表，目前支持 C++ 版本最高到 C++17，对 C++20 有部分支持。

项目快速启动

安装

首先，确保你已经安装了必要的依赖，包括 Clang 和 LibTooling。然后，你可以通过以下命令克隆并安装 clang-uml：

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

生成图表

创建一个 YAML 配置文件 config.yaml，内容如下：

compilation_database_dir: "build"
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'

运行 clang-uml 生成图表：

clang-uml config.yaml

生成的图表将位于 diagrams 目录中。

应用案例和最佳实践

案例一：文档化遗留代码

假设你有一个复杂的遗留 C++ 项目，你可以使用 clang-uml 生成类图和序列图，帮助你更好地理解代码结构和交互。通过配置文件中的 include 和 exclude 选项，你可以精确控制哪些部分被包含在图表中。

案例二：维护代码库文档

在持续开发的项目中，代码结构和交互可能会频繁变化。使用 clang-uml，你可以定期生成最新的 UML 图表，确保文档与代码同步。通过配置文件中的 glob 选项，你可以指定需要包含的文件和目录。

典型生态项目

Clang LibTooling

Clang LibTooling 是一个基于 Clang 的 C++ 库，用于创建各种工具。clang-uml 依赖于 Clang LibTooling 来解析和处理 C++ 代码。

PlantUML

PlantUML 是一种用于生成 UML 图表的语言和工具。clang-uml 支持生成 PlantUML 格式的图表，便于进一步编辑和查看。

MermaidJS

MermaidJS 是一个基于 JavaScript 的图表和图表工具。clang-uml 也支持生成 MermaidJS 格式的图表，适合在网页中嵌入和展示。

通过结合这些工具，clang-uml 提供了一个强大的生态系统，帮助开发者更好地理解和维护 C++ 项目。

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