C4Sharp 使用指南

项目介绍

C4Sharp（C4S）是一个基于.NET的库，用于以代码方式构建C4模型图。它扩展了C4-PlantUML的功能，使得开发者能够通过C#语言创建、分享和消费上下文图、容器图、组件图及部署图等C4模型图。该库支持输出PNG和SVG格式的图表，为软件设计和架构的可视化提供了强大的编程接口。

项目快速启动

环境准备

确保你的开发环境已安装 .NET 6.0 或更高版本以及 Java，因为C4Sharp依赖于这些工具运行。接下来，通过NuGet包管理器添加C4Sharp到你的项目中：

dotnet add package C4Sharp --version 7.0.189

或者，在你的.csproj文件中手动添加以下引用：

<PackageReference Include="C4Sharp" Version="7.0.189" />

创建第一个图示

在你的项目中，编写一个简单的类来继承自C4Sharp提供的图表类型之一，例如创建一个上下文图(ContextDiagram)的基本框架：

using C4Sharp.Models;

public class MyContextDiagram : ContextDiagram
{
    public override void Build()
    {
        Person("users", "系统用户");
        System_("mySystem", "我的系统", "这是一个演示系统");
    }
}

之后，你可以使用C4Sharp的API或命令行工具来编译这段代码成图像。

应用案例和最佳实践

在实际开发中，C4Sharp可以用来在项目初期快速地定义系统边界、主要角色以及系统结构。最佳实践包括：

1. 系统设计阶段：通过编写C4模型代码，团队成员可以在不离开代码编辑器的情况下讨论并迭代系统架构。
2. 技术文档：将架构动态生成到文档中，确保文档总是反映最新的设计状态。
3. 团队沟通：利用自动化的图示更新，简化对系统的理解和交流过程。

示例：在需求分析时，通过上述简单代码段展示系统与用户的关系，快速传达系统概览。

典型生态项目

虽然直接提及的“典型生态项目”信息在给定的引用内容中未提供，但可以推断C4Sharp可与任何使用.NET技术栈的软件开发项目集成，特别是在敏捷开发流程中，与持续集成(CI)和持续部署(CD)工具结合，自动化生成和更新架构图，提升项目透明度和维护性。

---

以上是基于C4Sharp项目的快速入门和基本使用说明。深入探索其功能和高级用法，请参考官方GitHub仓库中的文档和示例项目。