Skip to content

一个在 JetBrains 上的插件:Tree Description 。可以为项目模块增加自定义备注,颜色分类、标注用途,还可以共享开源映射关系。

Notifications You must be signed in to change notification settings

JaysonX-Tech/tree-description-plugin

Repository files navigation

image

项目简介

Tree Description - 项目树备注工具
为 IntelliJ IDEA 项目树添加路径备注,帮助开发者快速理解项目结构和代码含义。

核心功能

  • 自定义备注: 在包名和文件上添加自定义路径备注
  • Windows: Alt + Shift + A
  • Mac: Option + Shift + A
  • 实时显示: 项目树中实时显示备注说明
  • 映射库: 预置常用框架映射库
  • 自动匹配: 支持文件名和包名模式匹配
  • 提取注释: 支持提取类注释到文件备注说明
  • Windows: Alt + Shift + E
  • Mac: Option + Shift + E
  • 国际化: 支持中英文界面切换
  • 颜色标记: 支持自定义备注颜色

使用场景

  • 学习大型开源项目: 快速理解项目结构和模块职责
  • 团队协作: 统一项目命名规范和代码理解
  • 编程教学: 为学员提供清晰的项目结构说明
  • 代码审查: 快速识别文件功能和包的作用

贡献指南

欢迎提交 Issue 和 Pull Request!

支持

如果这个插件对你有帮助,欢迎给我们一个 ⭐ Star!


Project Introduction

Tree Description
Add intelligent path annotations to IntelliJ IDEA project tree, helping developers quickly understand project structure and code meaning.

Core Features

  • Smart Annotations: Add custom path annotations to package names and files
  • Windows: Alt + Shift + A
  • Mac: Option + Shift + A
  • Real-time Display: Display annotation descriptions in real-time in project tree
  • Extract Comments: Support extracting class comments into file comments
  • Mapping Library: Pre-built common framework mapping libraries
  • Auto Matching: Support filename and package name pattern matching
  • Windows: Alt + Shift + E
  • Mac: Option + Shift + E
  • Internationalization: Support Chinese and English interface switching
  • Color Marking: Support custom annotation colors

Use Cases

  • Learning Large Open Source Projects: Quickly understand project structure and module responsibilities
  • Team Collaboration: Unify project naming conventions and code understanding
  • Programming Education: Provide clear project structure explanations for students
  • Code Review: Quickly identify file functions and package purposes

Contributing

Welcome to submit Issues and Pull Requests!

Support Us

If this plugin helps you, welcome to give us a ⭐ Star!

About

一个在 JetBrains 上的插件:Tree Description 。可以为项目模块增加自定义备注,颜色分类、标注用途,还可以共享开源映射关系。

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages