3.2 KiB
3.2 KiB
StrayFog 框架开发流程指南
一、文档学习阶段
1.1 必读文档清单
| 优先级 | 文档路径 | 目的 |
|---|---|---|
| P0 | 01_框架架构/StrayFog框架架构分析.md |
理解框架整体架构 |
| P0 | 02_开发规范/开发规范指南.md |
掌握编码规范和命名约定 |
| P1 | 03_核心功能/事件系统使用指南.md |
理解事件驱动机制 |
| P1 | 03_核心功能/对象池使用指南.md |
掌握对象池复用机制 |
| P1 | 03_核心功能/资源管理使用指南.md |
理解资源加载流程 |
1.2 功能专项文档
根据开发任务类型,必须阅读对应的专项指南:
| 任务类型 | 必读文档 |
|---|---|
| UI开发 | 03_核心功能/UI/UI开发指南.md |
| UI界面设计 | 03_核心功能/UI/UI界面拼接设计指南.md |
| 相机控制 | 03_核心功能/相机系统使用指南.md |
1.3 输出要求
完成文档学习后,开发人员必须输出:
- 工作流程说明:详细描述从需求到交付的完整步骤
- 技术选型说明:明确使用的框架组件和API
- 风险评估:识别潜在问题和解决方案
二、需求分析
2.1 需求分析步骤
- 明确需求:理解业务需求,确定需要实现的功能
- 评估复杂度:判断是否需要核心库支持或扩展
- 设计方案:规划代码结构和调用关系
三、代码编写
3.1 代码编写步骤
- 创建目录:在
GameBusiness下创建对应模块目录 - 编写代码:遵循编码规范,使用核心库提供的API
- 测试验证:在Unity中测试功能正确性
四、代码审查
4.1 代码审查流程
- 自我检查:检查是否符合规范,是否有潜在问题
- 团队审查:提交代码进行团队审查
- 修复问题:根据审查意见修改代码
五、集成测试
5.1 测试阶段
- 模块测试:测试单个模块功能
- 集成测试:测试模块间交互
- 回归测试:确保不影响现有功能
六、Git提交规范
6.1 提交格式要求
所有代码提交必须遵循以下格式:
【操作原因】具体操作内容
6.2 操作原因分类
| 分类 | 说明 | 适用场景 |
|---|---|---|
| 【初始化】 | 首次创建或上传 | 新项目初始化、首次上传文档 |
| 【更新】 | 修改或完善现有内容 | 更新文档、优化代码 |
| 【新增】 | 添加新文件或功能 | 新增文档、新增代码模块 |
| 【修复】 | 修复错误或问题 | 修复Bug、修正文档错误 |
| 【重构】 | 重构代码或文档结构 | 优化架构、重新组织文档 |
| 【删除】 | 删除文件或功能 | 删除无用文件、移除废弃代码 |
| 【配置】 | 修改配置文件 | 更新配置、调整参数 |
6.3 提交示例
git commit -m "【更新】修复UI窗口打开时的空指针异常"
git commit -m "【新增】添加战斗系统核心模块"
git commit -m "【修复】修正开发流程指南中的错误描述"
版本: v1.0
生效日期: 2026年
适用范围: GiftGameX项目业务开发人员