docs:补充接口文档并更新项目说明

This commit is contained in:
2026-03-10 16:22:13 +08:00
parent 8123bc6b22
commit 0b0bdbacfa
3 changed files with 2509 additions and 14 deletions

View File

@@ -155,9 +155,9 @@ WhaleTown/ # 🐋 项目根目录
│ ├── performance/ # ⚡ 性能测试(帧率、内存优化)
│ └── api/ # 🌐 API接口测试
└── 🌐 web_assets/ # 🌍 Web导出资源
├── html/ # 📄 HTML模板文件
├── css/ # 🎨 样式文件
└── js/ # 📜 JavaScript脚本
├── html/ # 📄 HTML模板文件
├── css/ # 🎨 样式文件
└── js/ # 📜 JavaScript脚本
```
### 🔧 核心架构说明

View File

@@ -66,10 +66,10 @@
```gdscript
extends GutTest
func test_event_emission():
var sender = Node.new()
watch_signals(EventSystem)
EventSystem.emit_event(EventNames.PLAYER_MOVED, {})
assert_signal_emitted(EventSystem, "event_raised")
var sender = Node.new()
watch_signals(EventSystem)
EventSystem.emit_event(EventNames.PLAYER_MOVED, {})
assert_signal_emitted(EventSystem, "event_raised")
```
## 🔄 8. Standard Development Workflow (MANDATORY)
@@ -152,13 +152,13 @@ class_name Player
# 3. Lifecycle
func _physics_process(delta: float) -> void:
_move(delta)
_move(delta)
# 4. Private Methods
func _move(_delta: float) -> void:
var dir := Input.get_vector("move_left", "move_right", "move_up", "move_down")
velocity = dir * move_speed
move_and_slide()
var dir := Input.get_vector("move_left", "move_right", "move_up", "move_down")
velocity = dir * move_speed
move_and_slide()
```
## 10. 🔄 Plan Mode Protocol (MANDATORY)
- **Planning Phase**:
@@ -166,9 +166,9 @@ func _move(_delta: float) -> void:
- **Execution & Reporting**:
- Every time a TODO item is completed, the corresponding `.md` document MUST be updated.
- After updating the document, report to the user with the following:
1. **Completed Items**: What was just finished.
2. **User Acceptance Rules**: Instructions on how the user can test/verify the current progress.
3. **Next Step**: The next TODO item to be tackled.
1. **Completed Items**: What was just finished.
2. **User Acceptance Rules**: Instructions on how the user can test/verify the current progress.
3. **Next Step**: The next TODO item to be tackled.
- **Strict Confirmation**:
- After reporting progress, **Claude MUST stop and wait**.
- Do NOT proceed to the next TODO until the user has replied with confirmation/approval.

2495
docs/api-documentation.md Normal file

File diff suppressed because it is too large Load Diff