mirror of
https://github.com/motajs/template.git
synced 2026-11-02 06:34:31 +08:00
docs(10-20): 修订模板结构与注释(用户第5轮)
This commit is contained in:
1 parent
5dfcde853a
commit
2f181c8f2e
7 files changed
+210
-109
No files matched your search
@@ -189,3 +189,42 @@
|
||||
|
||||
**状态:处理中**
|
||||
|
||||
---
|
||||
|
||||
## 第 5 轮
|
||||
|
||||
**时间:** 2026-10-20
|
||||
**用户意见(7 条,多为长期结构规范):**
|
||||
|
||||
| # | 意见 | 落点 |
|
||||
|---|------|------|
|
||||
| U5-01 | 「插件解决什么问题」与「注册与目录」对调顺序 | `plugin-system.md` |
|
||||
| U5-02 | 数据端有 `getDataPlugin`,渲染端有 `getClientPlugin`,后者没讲 | `plugin-system.md` |
|
||||
| U5-03 | 模板不能只是把代码放那:先有描述(「如果想要…,可参考下述模板」)→ 模板 → 讲解它干了什么、声明了什么类、实现了什么接口、需要自己改什么 | 全部 |
|
||||
| U5-04 | 模板不放在文档最开头:先讲理念(能解决什么问题、可做哪些扩展),再展示模板,再围绕模板讲解 | 全部 |
|
||||
| U5-05 | Store 是纯接口讲解,不需要模板;模板只用于需要自己实现接口或注册的场景,纯接口只给示例 | `data-stores.md`(长期规范) |
|
||||
| U5-06 | Store 可以、也必须讲清楚存的对象类型,只是之前的写法读起来难受 | `data-stores.md` |
|
||||
| U5-07 | 示例代码注释太少;示例注释越多越好,以降低理解难度 | 全部 |
|
||||
|
||||
### 第 5 轮处置
|
||||
|
||||
**修改方式:** 内联执行(执行器直接编辑),仅修改 `docs/advanced/*.md` 与本职记录。
|
||||
|
||||
| # | 处置 |
|
||||
| ----- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| U5-01 | `plugin-system` 把「插件解决什么问题」移到「注册与目录」之前:开篇先讲插件解决什么问题、能承载哪些扩展,再看目录结构与注册位置。 |
|
||||
| U5-02 | `plugin-system` 将「用 getDataPlugin 取回」改为「用 getDataPlugin / getClientPlugin 取回」:数据端与渲染端各给一段完整示例(`state.getDataPlugin` / `state.getClientPlugin`),说明两者都返回只读包装对象、判空与状态检查一致。 |
|
||||
| U5-03 | 全部模板补齐三段结构:引导语(「如果想……,可以参考下面的模板」)→ 模板代码 → 说明声明了什么类、实现了什么接口、需要自己改什么。涉及插件两端模板、可存档三文件模板、录像 `ShopSystem` 模板、图层钩子模板、伤害计算器模板。 |
|
||||
| U5-04 | 模板不再出现在文档开头:`plugin-system` 先讲理念再看目录与注册,`saveable-content` 先讲「什么该存」再给模板,`replay-consistency` 先讲「什么该记」再给标记模板,`hooks-in-depth` 先讲「一个对象一个实例」再给图层钩子模板。 |
|
||||
| U5-05 | `data-stores` 去掉「模板」定位:读 Store 一节明确 Store 是纯接口使用、不是需要读者实现或注册的模板,只给一段读取示例(按 D-64 处理)。 |
|
||||
| U5-06 | 五个 Store 的「存什么」改为分段叙述:每条记录以什么为键、包含哪些字段、`eventPass` 等字段的含义,都在正文里讲清,不再用密集 inline-code 罗列。 |
|
||||
| U5-07 | 六篇示例补足解释性注释:`plugin-system` 的 `MyPlugin` / `MyClientPlugin` / `DataShopPlugin` / `MainDataPlugin` / 消费者插件,`saveable-content` 的 `MySaveable` / `MyPlugin` / `ShopManager`,`replay-consistency` 的 `ShopSystem`,`hooks-in-depth` 的图层与地图钩子,`data-stores` 的读取示例,`declarative-vs-imperative` 的伤害计算器与钩子注册。 |
|
||||
| D-63 | 按上下文中的长期规范落实模板顺序:理念 → 引导语 → 模板 → 解释,适用于后续所有文档。 |
|
||||
| D-64 | 按上下文中的长期规范落实模板范围:只有需要读者实现接口或注册内容时才给模板;纯接口使用(如 Store)只给示例。 |
|
||||
| D-65 | 按上下文中的长期规范补足示例注释:示例必须带解释性注释,注释越多越好。 |
|
||||
|
||||
**构建:** `pnpm exec prettier --write docs/advanced/*.md` 后 `--check` 七篇通过;`pnpm exec tsx docs/.vitepress/init.ts && pnpm docs:build` 输出 `build complete`,无 dead link。
|
||||
|
||||
**状态:已处理**
|
||||
|
||||
|
||||
Reference in new issue
Block a user