Modelon Solutions

A fresh take on your ideas

VS Code and UML

Published by

on

As some of you know, i am a big fan of modeling and of UML.

I do not believe everything should be UML, but rather that UML should be used to express things faster than it is to write (and read) a word document.

My favorite UML tool is by far Sparx’s Enterprise Architect. Great, not so expensive and does everything.

Lately though,  I’ve had a different objective of, embedding UML documentation directly inside the git repository along the source code. Enterprise Architect doesn’t really work like this because it is a single file that holds all of the data and doesn’t version correctly “the git way”.

Markdown format (supported natively by Visual Studio Code) is great first step or that because it is a lightweight method to organize text and can be diffed and compared.  The problem – no diagrams – until now 🙂

By adding this (YUML by Jaime Olivares) extension to Visual Studio Code, you can create .yuml files (based on the great syntaxes at yuml.me), and preview them directly in vs code. The advantages are since it is a easily readable text format, comparing and diffing is super easy… I LOVE THIS EXTENSION !!!!!

yuml

 

One response to “VS Code and UML”

  1. Jaime Avatar
    Jaime

    Hey there, thanks for reviewing my yUML extension for VSCode. I just released a new version with sequence diagram and embedding into markdown documents. Have a look!!

    Like

Leave a comment