mirror of
https://github.com/motajs/template.git
synced 2026-10-15 09:50:16 +08:00
docs(09): record task 3 review fixes R-1..R-5 (TextContent, jsDoc, JSX comments, no unnecessary exports)
This commit is contained in:
parent
a495928c55
commit
48dbf4ba2a
@ -115,12 +115,15 @@
|
||||
- **shop**:`ShopState` 接口**已提供(实现待补)**,可用于 UI 参数与编写。
|
||||
- **`<icon>`**:其实现为 **legacy**,需后续改造;**当前以它占位**。
|
||||
|
||||
### 任务 3 · 复查修正(四个 UI 完成后一并处理)
|
||||
### 任务 3 · 复查修正(四个 UI 已完成,现一并处理)
|
||||
|
||||
> 用户复查 book 输出后提出的两点,**暂不改**;待 book/equipbox/toolbox/shop **四个 UI 全部完成后一并修正**(并适用于四个 UI)。
|
||||
> 用户复查四个 UI 输出后提出的关键要求;待 book/equipbox/toolbox/shop **四个 UI 全部完成后一并修正**(**现在四个 UI 均已完成**),统一适用于这四个 UI(如适用亦可推广到其它 UI)。
|
||||
|
||||
- **R-1(不写 UI 背景):** UI 内**不自行绘制背景**;UI 系统有专门的**背景控制器**,应交由它处理。
|
||||
- **R-2(长文本用 TextContent):** 长文本(如**特殊属性描述**)用 **`TextContent` 组件**渲染,**不要用 `text`**。
|
||||
- **R-2(长文本必须用 `TextContent`):** 长文本(如**特殊属性描述**)**必须用 `TextContent` 组件**渲染,**不要用 `text`**——`text` **不支持换行**,只有 `TextContent` 才能**多行渲染并支持换行**以及一些自身控制符。
|
||||
- **R-3(顶层定义的 jsDoc):** 为组件**顶层定义的每个变量 / 常量 / 函数**添加 **jsDoc 注释**。
|
||||
- **R-4(JSX 分段注释):** 可给组件的 **JSX 部分添加注释**,标明每段负责的内容。
|
||||
- **R-5(按需导出):** **不需要导出的类型不要导出**(例如 `IShopItemEntry` 应不导出)。
|
||||
|
||||
### the agent's Discretion
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user