让嗒啦啦生成一份“AI优先”的开发规范文档

05/1994 浏览开发交流

这个攻略是干嘛的？

嗒啦啦是TapTap制造里的AI助手，专门帮你做小游戏。但有时候它生成的代码比较“野”——变量名乱起、逻辑全塞在一个文件里、改起来头大。

这篇攻略教你让嗒啦啦自己生一份 .md 规范文档。这份文档是写给嗒啦啦自己看的，下次生成代码时它会按这个规范来写，可维护性会好很多。

第一步：让嗒啦啦生成规范文档

直接在对话框里说：

“嗒啦啦，帮我生成一份 game_guidelines.md，内容是你自己写代码时必须遵守的规范。要包括：代码怎么组织、文件怎么放、变量怎么命名、怎么记录修改历史。”

嗒啦啦会给你一份文档，大概长这样：

```markdown

# 嗒啦啦游戏代码规范

## 文件结构

- 每个场景一个lua文件

- 公共函数放在 `utils.lua`

- 数据配置放在 `config.lua`

## 命名规则

- 全局变量用 `g_` 开头

- 函数名用动词+名词，比如 `movePlayer`

- 常量全大写，比如 `MAX_SPEED`

## 代码组织

- 单个函数不要超过30行

- 相同逻辑出现两次就要抽成函数

- 重要步骤要写注释，但别每一行都写

## 版本记录

- 每次大改后在文件头部加上 `-- 修改日期：xxxx 修改人：嗒啦啦改了什么`

```

第二步：补充“嗒啦啦容易犯的毛病”

你自己用几次嗒啦啦之后，会发现它有些固定毛病。直接追加到规范文档里。

比如你可以说：

“在规范里加一条：禁止在 update 函数里写复杂逻辑，复杂逻辑必须拆成单独的函数。”

或者：

“加一条：碰撞检测相关的代码必须集中放在 collision.lua 里，不要散落在各个场景文件中。”

第三步：让嗒啦啦按规范生成代码

下次你让嗒啦啦做游戏功能时，先发这句话：

“先读取 game_guidelines.md，按里面的规范写代码。”

嗒啦啦就会照着它自己写的规范去生成，不会乱来了。

还缺什么？你自己补充这几条

嗒啦啦不懂“可维护性”这种抽象词，你要写成它听得懂的指令。这几条建议加进规范里：

1. 文件管理

· 一个文件只放一类东西。所有UI代码放一个文件，所有音效代码放另一个。

· 文件超过200行就警告，超过300行必须拆。

2. 避免魔法数字

· 不许写 if hp < 30，要写成 if hp < MIN_HEALTH，然后在文件开头定义 MIN_HEALTH = 30。

3. 改动记录

· 每次修改代码后，在文件末尾追加一段 -- [日期] 修改说明，方便你回头查。

4. 错误处理

· 所有加载资源的地方都要加判断：如果资源不存在，打印错误但不要让游戏崩溃。

5. 不要硬编码

· 关卡数据、角色属性这些东西单独放一个 data.lua，不要写在游戏逻辑里。

一个实际例子

你直接复制下面这段话发给嗒啦啦，它就能生成一份可用的规范：

“嗒啦啦，帮我生成一份代码规范文档，内容如下：

1. 文件按功能拆分：main.lua、player.lua、enemy.lua、utils.lua、config.lua。

2. 所有数值配置（比如血量、速度）都放在config.lua里。

3. 函数名用小驼峰，变量名用下划线。

4. 每次修改后在文件头部写备注，格式：-- v1.1 改了什么。

5. 不要在一个函数里写超过40行代码。

6. 不要用数字直接做判断，先定义常量。”

最后提醒

嗒啦啦是按照你给的规范来执行的，但它不会主动“思考”怎么改进规范。如果你发现它又犯了老毛病，就回到规范文档里，把那条规则写得更清楚，或者直接说“在规范里禁止xxxx”。

用熟了之后，你甚至可以准备两套规范：一套给嗒啦啦默认用，一套在复杂项目时切换。

TapTap 制造应用

9.8

前往论坛