I wanted to build an utility app to create UML Class diagrams from java code. But didn't wanted to spend so much to draw it. So, I created this project using annotations @SuperClass
and @ChildClass
above the class declaration, project will create new mermaid markdown code for UML class diagrams.
I used java
, markdown
and mermaid
. I have used java Reflection API for scanning all the classes in the package. And some basic annotation processing.
- You should have installed Jdk1.8
- Clone the repository or download the zip.
- Run Main class file for running the app. It will create new sample file just like this in markdown directory
- You can change
packagePath
if you want to point out to some other class hierarchy. - To view that markdown you can use VSCode Markdown preview extension or github gist or any markdown renderer. You should be able to see out output something like this.
Project is completed with all the features. You can request for new features. or Fork and create PR for the same.
List of contriubutors: