【重构】整理文档目录结构,创建5个分类文件夹,拆分业务开发指南为8个独立文档,添加README入口导航

This commit is contained in:
Shiliang
2026-05-22 10:41:34 +08:00
parent 4139f8d392
commit e4198ddd16
13 changed files with 710 additions and 567 deletions

View File

@@ -0,0 +1,46 @@
# StrayFog 框架常见问题指南
## 一、常见问题解答
### 1.1 如何扩展核心库功能?
通过继承抽象类或实现接口来扩展,不要直接修改核心库代码。
### 1.2 核心库有Bug怎么办
提交Issue到框架团队由框架团队修复并发布新版本。
### 1.3 如何获取核心库的最新版本?
关注内部通知,定期更新核心库引用。
### 1.4 如何调试核心库代码?
可以设置断点调试,但不允许修改代码。
---
## 附录
### A. 常用核心库API
| 类别 | 管理器 | 常用方法 |
|-----|-------|---------|
| **对象池** | `HFObjectMemPool` | `GetItem()`, `GiveBack()` |
| **事件** | `IHFEventHandle` | `AddListener()`, `Dispatch()` |
| **资源** | `HFABMgr` | `OnStartLoad()` |
| **相机** | `HFCameraManager` | `AddCamera()`, `GetCamera()` |
### B. 核心库只读目录
```
Assets/StrayFog/Core/
Assets/Game/GameHFScripte/CopyToHF/
Assets/Game/GameGeneralScripte/
```
---
**版本**: v1.0
**生效日期**: 2026年
**适用范围**: GiftGameX项目业务开发人员

View File

@@ -0,0 +1,45 @@
# StrayFog 框架开发流程指南
## 一、需求分析
### 1.1 需求分析步骤
1. **明确需求**:理解业务需求,确定需要实现的功能
2. **评估复杂度**:判断是否需要核心库支持或扩展
3. **设计方案**:规划代码结构和调用关系
---
## 二、代码编写
### 2.1 代码编写步骤
1. **创建目录**:在`GameBusiness`下创建对应模块目录
2. **编写代码**遵循编码规范使用核心库提供的API
3. **测试验证**在Unity中测试功能正确性
---
## 三、代码审查
### 3.1 代码审查流程
1. **自我检查**:检查是否符合规范,是否有潜在问题
2. **团队审查**:提交代码进行团队审查
3. **修复问题**:根据审查意见修改代码
---
## 四、集成测试
### 4.1 测试阶段
1. **模块测试**:测试单个模块功能
2. **集成测试**:测试模块间交互
3. **回归测试**:确保不影响现有功能
---
**版本**: v1.0
**生效日期**: 2026年
**适用范围**: GiftGameX项目业务开发人员

View File

@@ -0,0 +1,49 @@
# StrayFog 框架最佳实践指南
## 一、性能优化
### 1.1 对象池使用
- 频繁创建销毁的对象必须使用对象池
- 合理设置对象池初始容量
- 定期清理空闲对象避免内存泄漏
### 1.2 资源管理
- 及时释放不再使用的资源
- 使用异步加载避免卡顿
- 合理使用资源缓存
---
## 二、代码组织
### 2.1 单一职责
- 每个类只负责一个功能
- 避免庞大的God类
### 2.2 依赖管理
- 通过管理器获取依赖,而非硬编码
- 使用接口解耦依赖关系
---
## 三、错误处理
### 3.1 异常捕获
- 在关键路径添加异常处理
- 记录错误日志便于排查
### 3.2 防御性编程
- 检查参数合法性
- 处理空引用情况
---
**版本**: v1.0
**生效日期**: 2026年
**适用范围**: GiftGameX项目业务开发人员