Skip to content

模块与文档对照表

本文档提供项目目录与相关文档的快速映射,帮助开发者快速定位所需文档。

📋 目录结构到文档的映射

项目目录组件类型主要文档说明
ColorVision/主程序入门指南 <br> 主窗口导览WPF应用程序入口
Engine/核心引擎Engine组件概览引擎层总入口
└─ ColorVision.Engine/主引擎ColorVision.Engine <br> 设备服务概览 <br> 算法引擎与模板核心业务逻辑
└─ cvColorVision/视觉处理cvColorVisionC++视觉算法库
└─ FlowEngineLib/流程引擎FlowEngineLib <br> 流程引擎架构 <br> 流程引擎可视化流程编辑器
└─ ColorVision.FileIO/文件IOColorVision.FileIO文件读写处理
└─ ST.Library.UI/UI库ST.Library.UIUI辅助库
UI/UI层UI组件概览UI层总入口
└─ ColorVision.UI/UI框架ColorVision.UI <br> 属性编辑器 <br> 热键系统设计主UI框架
└─ ColorVision.Common/通用组件ColorVision.Common通用UI控件
└─ ColorVision.Core/核心组件ColorVision.Core核心UI组件
└─ ColorVision.Themes/主题ColorVision.Themes主题和样式
└─ ColorVision.ImageEditor/图像编辑器ColorVision.ImageEditor <br> 图像编辑器专业图像编辑
└─ ColorVision.Solution/解决方案ColorVision.Solution工程文件管理
└─ ColorVision.Scheduler/调度器ColorVision.Scheduler任务调度UI
└─ ColorVision.Database/数据库UIColorVision.Database数据库界面
└─ ColorVision.SocketProtocol/SocketColorVision.SocketProtocolSocket协议
Plugins/插件插件管理 <br> 开发插件指南插件系统
└─ Pattern/图案检测Pattern插件图案检测插件
└─ Spectrum/光谱仪Spectrum插件光谱仪测试插件
└─ SystemMonitor/系统监控系统监控插件性能监控
└─ EventVWR/事件查看使用标准插件事件查看器
└─ ScreenRecorder/屏幕录制-录屏功能
└─ WindowsServicePlugin/服务插件-Windows服务
Projects/客户项目各项目README.md定制化项目
Core/底层库-C++底层库
Test/测试-单元测试
Tools/工具-辅助工具
ColorVisionSetup/安装程序自动更新安装和更新
docs/文档在线文档VitePress站点

🎯 按功能域查找文档

设备管理相关

算法与模板相关

流程引擎相关

UI组件相关

架构设计相关

插件开发相关

数据存储相关

部署和更新相关

性能优化相关

安全与权限相关

扩展性开发相关

故障排查相关

🔍 按开发任务查找

我想添加新设备

  1. 了解设备服务架构:设备服务概览
  2. 查看现有设备实现:Engine/ColorVision.Engine/Services/Devices/
  3. 参考添加设备文档:添加与配置设备

我想开发插件

  1. 阅读插件开发指南:开发插件指南
  2. 了解插件管理机制:插件管理
  3. 查看标准插件示例:Plugins/Pattern/, Plugins/Spectrum/, Plugins/SystemMonitor/
  4. 参考插件生命周期:插件生命周期

我想添加算法模板

  1. 了解模板系统:算法引擎与模板
  2. 查看模板架构:Templates架构设计
  3. 参考现有模板:Engine/ColorVision.Engine/Templates/
  4. 了解JSON模板:基于JSON的通用模板

我想自定义UI组件

  1. 了解UI架构:UI组件概览
  2. 查看ColorVision.UI:ColorVision.UI
  3. 了解主题系统:ColorVision.Themes
  4. 参考属性编辑器:属性编辑器

我想添加流程节点

  1. 了解流程引擎:流程引擎
  2. 查看FlowEngineLib架构:FlowEngineLib架构
  3. 阅读节点开发指南:节点开发指南
  4. 参考现有节点:Engine/FlowEngineLib/

我想理解系统架构

  1. 从概览开始:系统架构概览
  2. 了解运行时:架构运行时
  3. 查看组件交互:组件交互矩阵
  4. 参考项目结构:项目结构总览

📖 新手推荐阅读顺序

  1. 第一步什么是ColorVision
  2. 第二步入门指南
  3. 第三步项目结构总览 ← 当前文档
  4. 第四步系统架构概览
  5. 第五步:根据你的角色选择:

🚀 快速链接

Released under the MIT License.