58 lines
2.1 KiB
Markdown
58 lines
2.1 KiB
Markdown
# StandardScene 文档导航
|
|
|
|
## 1. 文档入口
|
|
|
|
| 文档 | 适合谁 | 用途 |
|
|
| --- | --- | --- |
|
|
| `DocumentHub.html` | 所有人 | 单文件浏览入口，双击直接打开 |
|
|
| `README.md` | 第一次接触仓库的人 | 快速了解项目定位与运行方式 |
|
|
| `DEVELOPMENT_GUIDE.md` | 要开始开发的人 | 系统化理解架构、模块、配置、案例 |
|
|
| `QUICK_REFERENCE.md` | 正在写代码的人 | 快速查入口、路径、配置、排错点 |
|
|
|
|
## 2. 推荐阅读路线
|
|
|
|
### 路线 A：第一次接触仓库
|
|
|
|
1. 打开 `DocumentHub.html`
|
|
2. 阅读 `README.md`
|
|
3. 阅读 `DEVELOPMENT_GUIDE.md`
|
|
4. 打开 `Scheduler\HeartBeatMission.cs`
|
|
5. 动手做 HelloMission 案例
|
|
|
|
### 路线 B：已经会跑工程，准备开发
|
|
|
|
1. 阅读 `QUICK_REFERENCE.md`
|
|
2. 根据目标定位目录
|
|
3. 找最接近的参考类
|
|
4. 写代码
|
|
5. 回到 `DEVELOPMENT_GUIDE.md` 查配置与调试建议
|
|
|
|
### 路线 C：准备改真实业务逻辑
|
|
|
|
1. 先确认变更属于哪个模块
|
|
2. 如果是调度，看 `Chained\`
|
|
3. 如果是联动控制，看 `Scheduler\` 或 `InterLock\`
|
|
4. 如果是设备或协议，看 `CarTypes\`、`Charge\`、`ExtendDevice\Door\`
|
|
5. 如果是外部系统接入，看 `WebApi.cs`
|
|
|
|
## 3. 按目标查文件
|
|
|
|
| 目标 | 直接打开这些文件 |
|
|
| --- | --- |
|
|
| 了解插件怎么被宿主识别 | `Scheduler\HeartBeatMission.cs` |
|
|
| 做区域流量限制 | `Scheduler\RegionalTrafficControlMission.cs` |
|
|
| 做搬运调度 | `Chained\AbstractChainedDeliveryMission.cs`、`Chained\TransportMission.cs` |
|
|
| 做充电策略 | `Charge\AbstractChargeLogicMission.cs`、`Charge\StandardChargeMission.cs` |
|
|
| 查 API | `WebApi.cs` |
|
|
| 查通用工具 | `Commons.cs` |
|
|
|
|
## 4. 本地打开 HTML 文档
|
|
|
|
直接双击 `DocumentHub.html` 即可，无需任何部署。页面已内嵌样式与脚本，并显式声明 `UTF-8` 编码。
|
|
|
|
## 5. 建议的第一个练习
|
|
|
|
1. 按 `DEVELOPMENT_GUIDE.md` 的案例 A 新建 `HelloMission`
|
|
2. 编译后打开 `build\SimpleComposer.exe`
|
|
3. 启动 Mission，确认状态每秒递增
|
|
4. 再按案例 B 给站点添加 `Region1=1`，体验区域流控 |