【亲测免费】 C4-PlantUML 项目教程

1. 项目的目录结构及介绍

C4-PlantUML 是一个用于生成架构图的开源项目，基于 PlantUML 和 C4 模型。项目的目录结构如下：

C4-PlantUML/
├── LICENSE
├── README.md
├── docs/
│   ├── C4_Container.puml
│   ├── C4_Context.puml
│   ├── C4_Component.puml
│   └── ...
├── src/
│   └── ...
└── tests/
    └── ...

• LICENSE：项目的许可证文件。
• README.md：项目的介绍文档。
• docs/：包含各种 C4 模型的示例文件。
• src/：项目的源代码文件夹。
• tests/：项目的测试文件夹。

2. 项目的启动文件介绍

C4-PlantUML 项目的启动文件主要是 docs/ 文件夹中的 .puml 文件。这些文件定义了如何使用 C4 模型来绘制架构图。以下是一些关键的启动文件：

• C4_Context.puml：定义了系统上下文图的绘制方法。
• C4_Container.puml：定义了容器图的绘制方法。
• C4_Component.puml：定义了组件图的绘制方法。

这些文件可以通过 PlantUML 工具进行渲染，生成可视化的架构图。

3. 项目的配置文件介绍

C4-PlantUML 项目本身没有特定的配置文件，因为它是基于 PlantUML 的扩展。用户在使用时，主要通过修改 .puml 文件中的内容来调整生成的架构图。例如，可以在 .puml 文件中添加或修改元素、关系等，以满足特定的需求。

例如，在 C4_Context.puml 文件中，可以添加新的系统或修改现有系统的描述：

@startuml
!include https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4_Context.puml

Person(user, "用户", "使用系统的用户")
System(system, "系统", "核心业务系统")

Rel(user, system, "使用")
@enduml

通过这种方式，用户可以根据自己的需求定制架构图的内容和样式。