项目规范.md

项目规范

0. 基本规范

• 项目名称

  • 浅海寻珍记

• 命名空间

  • 不使用命名空间

• 命名风格

  • Google开源项目风格指南
    • 命名约定

• 码风(缩进等)

  • Clang-Format

  • 配置文件（参考）

    BasedOnStyle: Google
    ColumnLimit: 130
    IndentWidth: 4
    TabWidth: 4
    UseTab: Never

1. 模块

1.1 模块划分

• 菜单/UI模块
  • 主菜单、进入游戏、退出游戏、注册登录、帮助、设置等
• 游戏核心模块
  • 游戏主循环、业务逻辑、数据存储、宝石位置、宝石运动等
• 辅助模块
  • 数据库、排行榜等
• 3D模块

1.2 例

• 开启游戏，显示主菜单（菜单系统）
• 点击“开始游戏”按钮，菜单系统 调用 游戏核心系统
• 玩家点击，菜单系统 收到指令，将指令传给 核心系统，核心系统 做出对应反馈
• 核心系统 调用 3D系统，绘制出对应图形。
• 在主菜单中，玩家可以选择其他选项，调用对应的 辅助系统。

1.3 分工

• UI模块：FuLiqi
• 游戏核心模块：lovekdl
• 数据库、音乐&音效：Brony01
• 3D系统：YXHXianYu
• 美术：ZY_MC