用途
luau-best-practices 是面向 Roblox 游戏开发的 Luau 编码规范与模式参考,主要用于在编写、审查、重构 Luau 代码(模块、服务、控制器、错误处理、内存泄漏与连接清理等)时提供一致的实践依据。
核心原则
- 服务器权威:游戏状态由服务器拥有,客户端仅负责表现。
- 快速失败:尽早校验,开发期大声报错。
- 显式优于隐式:清晰意图胜过“聪明”的代码。
- 最小暴露面:只暴露必要内容。
代码风格
命名约定:
- PascalCase:类型、类、服务、模块;
- camelCase:变量、函数、方法;
- SCREAMING_SNAKE_CASE:常量;
- 下划线前缀表示私有。
文件内顺序:--!strict → 服务/导入 → 常量 → 类型 → 模块表 → 私有状态 → 私有函数 → 公共 API → return。
模块模式
提供 Service 模式(服务端)与 Controller 模式(客户端)示例。Service 通过 Start/Stop 管理初始化与热重载清理;Controller 以 Init(不 yield 的初始化)与 Start(连接事件、启动循环)组织客户端逻辑。文档另提及信号、状态管理、懒加载等模式位于 references/patterns.md。
错误处理
外部调用(如 DataStore、HTTP 及可能失败的 Roblox API)使用 pcall 并配合 warn 处理失败;编程错误使用 assert。