Skip to content

DarkReaperDev/Code2UML

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

71 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Code2UML

Code2UML is a open-source tool for creating UML diagrams from pseudo-code (syntax is pretty similar to java). It lets you focus more on your projects structure instead of thinking about designing diagrams and UML Standards.

+++ Version 1.1 is now out, adding support for implementing interfaces and extending classes! For more information see here.

Get it running

If you want to try it out yourself, you can either just donwload and run a compiled version or donwload the source code and compile it yourself.

Run compiled version

  1. If you havent already download the latest Java SE version here and install it.
  2. Select a released Version of the project from the releases tab and download the zip-folder with the versions name.
  3. Open the folder on your computer and double click the .jar named Code2UML + version name, for example : Code2UMLv.1.0.jar.
  4. If it doesnt work, open your command prompt or shell of choice and navigate to the folder where the .jar file is located. Then run java -jar filename.jar putting the name of the .jar file as filename.

Get started

  1. After running the programm, a blank editor window pops up, where you can write your uml code.

    a blank editor window

  2. Type in:

class HelloWorld{
    private string message;
    public bool isHappy;
    int GetSomeInt();
    public void DoSomething();
}
  1. In the upper left corner click on file and then run.

    editor file -> run

  2. Now a new window should pop up, containing a UML diagram of your class. Congrats, you created your first UML diagram!

    created uml diagram

  3. (Optionally) you can now save your uml script clicking on file and then save as. A window will show up where you can specify where you want to save the file. If you succesfulle saved your file you can always open it up again using file and then open. (It doesnt really matter if you save the file as a .txt or something else but I recommend saving it as a .uml file so you always know that it is more than just a text file.)

  4. For more information see documentation{coming soon}

Features

  • converting java-like code and into clean UML diagrams
  • currently supporting class, interface, member and method declarations
  • extending and implementing classes is also supported
  • handling and displaying errors containing error line number
  • saving and loading uml code

Planned Features

  • function to convert real language projects into uml diagrams
  • export funtion for UML diagrams