johnvonlzf / C4-CSharp

Generates C4 diagrams from C# (via PlantUML)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

C4-CSharp

Generates C4 diagrams from C# (via PlantUML)

If you have never heard of C4 models, check out https://c4model.com/

tldr;

Context, Containers, Components and Code

Overview

This is part of my growing collection of documentation tools. They will be based on the needs that I have run into. There will most likely be items that are not implemented yet.
If you find something missing, just let me know and it may be added to the backlog, for future releases.

This tool will allow you to write C# code and automatically generate png diagrams as a part of the build process. (Think nUnit and unit testing)

How to read a class diagram

https://plantuml.com/class-diagram

Class diagrams

The class diagram generator that is included in this project will reflect over a compiled assembly.
It is based on the work done in https://github.com/pierre3/PlantUmlClassDiagramGenerator.
If you have access to the source code, and this project is missing a feature, I would recommendd using Pierre's project.
I will continue to add features to this project as they become necessary or requested.

About

Generates C4 diagrams from C# (via PlantUML)


Languages

Language:C# 100.0%