xnyuq / CodeVisualizer

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Code Visualizer

The Code Visualizer project is a tool that allows users to visualize Java code in different formats, such as UML diagrams and XML schema. It leverages the JavaParser library for parsing Java source code and the PlantUML library for generating UML diagrams.

Table of Contents

Introduction

The Code Visualizer project aims to provide developers with a tool to visualize Java code for better understanding and analysis. It supports the generation of UML diagrams and XML schema from Java source code.

Features

  • Generate UML diagrams from Java source code
  • Generate XML schema from Java source code
  • Command-line interface for easy integration into workflows
  • Interactive rendering of PlantUML diagrams (PNG or ASCII)

Getting Started

Prerequisites

  • Java (JDK) installed on your machine
  • Maven for building and managing the project

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/code-visualizer.git
  2. Navigate to the project directory:

    cd code-visualizer
  3. Build the project using Maven:

    mvn clean install

Usage

Command-Line Options

The Code Visualizer supports the following command-line options:

  • -i or --input: Specify the input java source folder.
  • -g or --generate: Specify the output type (uml or xsd).
  • -o or --output: Specify the output folder path.
  • -r or --render: Specify the rendering format (png or ascii).

Example usage:

java -jar CodeVisualizer.jar -g uml -o output/ -r png

Generate UML Class Diagram as PNG Demo

Contributing

License

This project is licensed under the MIT License. Feel free to use, modify, and distribute the code for your own projects.

Acknowledgments

The Code Visualizer project wouldn't be possible without the contributions and support from the following:

Thank you to all the contributors and communities behind these fantastic tools!

About


Languages

Language:Java 78.3%Language:AspectJ 21.7%