模块与文档对照表
本文档提供项目目录与相关文档的快速映射,帮助开发者快速定位所需文档。
📋 目录结构到文档的映射
| 项目目录 | 组件类型 | 主要文档 | 说明 |
|---|---|---|---|
| ColorVision/ | 主程序 | 入门指南 <br> 主窗口导览 | WPF应用程序入口 |
| Engine/ | 核心引擎 | Engine组件概览 | 引擎层总入口 |
| └─ ColorVision.Engine/ | 主引擎 | ColorVision.Engine <br> 设备服务概览 <br> 算法引擎与模板 | 核心业务逻辑 |
| └─ cvColorVision/ | 视觉处理 | cvColorVision | C++视觉算法库 |
| └─ FlowEngineLib/ | 流程引擎 | FlowEngineLib <br> 流程引擎架构 <br> 流程引擎 | 可视化流程编辑器 |
| └─ ColorVision.FileIO/ | 文件IO | ColorVision.FileIO | 文件读写处理 |
| └─ ST.Library.UI/ | UI库 | ST.Library.UI | UI辅助库 |
| 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/ | 数据库UI | ColorVision.Database | 数据库界面 |
| └─ ColorVision.SocketProtocol/ | Socket | ColorVision.SocketProtocol | Socket协议 |
| Plugins/ | 插件 | 插件管理 <br> 开发插件指南 | 插件系统 |
| └─ Pattern/ | 图案检测 | Pattern插件 | 图案检测插件 |
| └─ Spectrum/ | 光谱仪 | Spectrum插件 | 光谱仪测试插件 |
| └─ SystemMonitor/ | 系统监控 | 系统监控插件 | 性能监控 |
| └─ EventVWR/ | 事件查看 | 使用标准插件 | 事件查看器 |
| └─ ScreenRecorder/ | 屏幕录制 | - | 录屏功能 |
| └─ WindowsServicePlugin/ | 服务插件 | - | Windows服务 |
| Projects/ | 客户项目 | 各项目README.md | 定制化项目 |
| Core/ | 底层库 | - | C++底层库 |
| Test/ | 测试 | - | 单元测试 |
| Tools/ | 工具 | - | 辅助工具 |
| ColorVisionSetup/ | 安装程序 | 自动更新 | 安装和更新 |
| docs/ | 文档 | 在线文档 | VitePress站点 |
🎯 按功能域查找文档
设备管理相关
- 目录:
Engine/ColorVision.Engine/Services/ - 文档:
算法与模板相关
- 目录:
Engine/ColorVision.Engine/Templates/ - 文档:
流程引擎相关
UI组件相关
架构设计相关
插件开发相关
数据存储相关
- 文档:
部署和更新相关
性能优化相关
- 文档:
安全与权限相关
扩展性开发相关
- 文档:
故障排查相关
- 文档:
🔍 按开发任务查找
我想添加新设备
我想开发插件
- 阅读插件开发指南:开发插件指南
- 了解插件管理机制:插件管理
- 查看标准插件示例:
Plugins/Pattern/,Plugins/Spectrum/,Plugins/SystemMonitor/ - 参考插件生命周期:插件生命周期
我想添加算法模板
- 了解模板系统:算法引擎与模板
- 查看模板架构:Templates架构设计
- 参考现有模板:
Engine/ColorVision.Engine/Templates/ - 了解JSON模板:基于JSON的通用模板
我想自定义UI组件
- 了解UI架构:UI组件概览
- 查看ColorVision.UI:ColorVision.UI
- 了解主题系统:ColorVision.Themes
- 参考属性编辑器:属性编辑器
我想添加流程节点
- 了解流程引擎:流程引擎
- 查看FlowEngineLib架构:FlowEngineLib架构
- 阅读节点开发指南:节点开发指南
- 参考现有节点:
Engine/FlowEngineLib/
