项目文档维护(一) 快速生成项目结构图

时间静止不是简史

发布于 2024-05-26 15:29:30

1190

发布于 2024-05-26 15:29:30

文章被收录于专栏：Java探索之路Java探索之路

IDEA快速生成项目树形结构图

1. 执行指令

在项目根目录下，进入cmd或terminal, 输入如下指令：

tree . > tr.txt 只有文件夹   
tree /f . > tr.txt  包括文件夹和文件

注意尽量要使用idea, pycharm等ide, 其他工具需自己测试效果, 本人使用power shell 只创建了一个空文件

执行过程如下图

执行后项目底部则生成对应文本

注意: 如果直接在idea编辑器中打开需要将格式转换成GBK格式才能查看, 否则显示乱码. 嫌麻烦可以直接通过电脑自带笔记本工具打开.

2. 修改树形结构图如下图所示

需要手动剔除多余的内容

文件夹 PATH 列表
卷序列号为 00000062 941E:6E86
C:\CODE\IDEA_CODE\项目名
├─file
├─lib
├─logs
├─src
│  ├─main
│  │  ├─java
│  │  │  └─com
│  │  │      └─公司名
│  │  │          └─项目简称
│  │  │              ├─annotation
│  │  │              ├─config
│  │  │              │  ├─cachePreHot
│  │  │              │  ├─filter
│  │  │              │  ├─jsr
│  │  │              │  ├─listener
│  │  │              │  └─mybatiesPlus
│  │  │              ├─constant
│  │  │              ├─controller
│  │  │              │  ├─approvalFlow
│  │  │              │  ├─contentPublish
│  │  │              │  ├─dailyOffice
│  │  │              │  ├─dingTalk
│  │  │              │  ├─project
│  │  │              │  ├─projectPlan
│  │  │              │  ├─rbac
│  │  │              │  ├─system
│  │  │              │  ├─unused
│  │  │              │  ├─weeklyReport
│  │  │              │  └─workTime
│  │  │              ├─entity
│  │  │              │  ├─dto
│  │  │              │  ├─enums
│  │  │              │  ├─po
│  │  │              │  ├─qo
│  │  │              │  └─vo
│  │  │              ├─exception
│  │  │              ├─mapper
│  │  │              ├─schedule
│  │  │              ├─service
│  │  │              │  └─impl
│  │  │              └─util
│  │  └─resources
│  │      ├─mapper
│  │      ├─public
│  │      │  └─static
│  │      │      ├─css
│  │      │      ├─js
│  │      │      └─media
│  │      ├─sql
│  │      └─static
│  └─test
│      └─java
│          └─com
│              └─公司名
│                  └─项目简称
│                      └─test
│                          └─poi
└─target
    ├─classes
    │  ├─com
    │  │  └─公司名
    │  │      └─项目简称
    │  │          ├─annotation
    │  │          ├─config
    │  │          │  ├─cachePreHot
    │  │          │  ├─filter
    │  │          │  ├─jsr
    │  │          │  ├─listener
    │  │          │  └─mybatiesPlus
    │  │          ├─constant
    │  │          ├─controller
    │  │          │  ├─approvalFlow
    │  │          │  ├─contentPublish
    │  │          │  ├─dailyOffice
    │  │          │  ├─dingTalk
    │  │          │  ├─project
    │  │          │  ├─projectPlan
    │  │          │  ├─rbac
    │  │          │  ├─system
    │  │          │  ├─unused
    │  │          │  ├─weeklyReport
    │  │          │  └─workTime
    │  │          ├─entity
    │  │          │  ├─dto
    │  │          │  ├─enums
    │  │          │  ├─po
    │  │          │  ├─qo
    │  │          │  └─vo
    │  │          ├─exception
    │  │          ├─mapper
    │  │          ├─schedule
    │  │          ├─service
    │  │          │  └─impl
    │  │          └─util
    │  ├─mapper
    │  ├─public
    │  │  └─static
    │  │      ├─css
    │  │      ├─js
    │  │      └─media
    │  ├─sql
    │  └─static

为相关包路径加上注释