# PanUmlTools

**Repository Path**: guo-dingyi/pan-uml-tools

## Basic Information

- **Project Name**: PanUmlTools
- **Description**: PanUmlTools项目一个java语言实现的，自动扫描java项目构建java项目的UML类图的项目。该项目主要利用了java反射技术实现。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-04-22
- **Last Updated**: 2024-05-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Java

## README

# PanUmlTools

#### 介绍

PanUmlTools项目一个java语言实现的，自动扫描java项目构建java项目的UML类图的项目。<br>
该项目主要利用了java反射技术实现对项目类信息的获取。


#### 软件架构



#### 安装教程

##### 1. 把项目 clone 到本地
##### 2. maven install 到本地的maven仓库
##### 3. 在你需要使用的项目中添加PanUmlTools依赖
```
<dependency>
    <groupId>com.pan</groupId>
    <artifactId>PanUmlTools</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>
```

#### 快速开始

##### 生成Uml类图

```
public class FastStart{
    public static void main(String[] args){
        //注意：请确保你所传入类的同级目录或者子目录包含该项目的所有类，以确保PanUmlTools能扫描到
        PanUML.run(Application.class);
    }
}
```
<br>
像该例子这样调用PanUml类的run静态方法，即可生成Uml类图的xml文件。 <br>
PanUmlTools会在项目跟目录的output文件夹中生成UML.xml文件，该文件可以在任意类似这样的绘图网站中打开 <br>
https://www.iodraw.com/ <br>
https://www.drawio.com/ <br>
即可查看该项目的所有类的UML类图 <br>

#### 生成效果
<br>
比如在这个网站中打开UML.xml的效果
<br>
```
https://www.drawio.com/ 
```
<br>

![生成效果](output/UML.jpg)


#### 参与贡献


#### 特技