docs: 同步 Doc 文档与当前代码状态
- 更新模块文件数(EPUBCore 31+2, EPUBTextRendering 13, ReaderView 5, EPUBUI 19) - 更新 Swift 版本(5.10)、iOS 版本(15.0)、行数等基本信息 - 补充新增文件文档(TextAnchor, RenderRequest, WebViewDebug, AssetRepository, TextIndexTable, TextPerformanceSampler, ChapterData, PageInteractionController 等) - 更新 RDEPUBLocation 模型(新增 rangeAnchor 字段) - 更新 RDEPUBReaderConfiguration(13 项配置)、Delegate 签名、Persistence(8 方法) - 修正 RDURLReaderController 归属(ReaderView → EPUBUI) - 移除过时的 LegacyRDReaderController 引用 - 标记 SS→RD 命名迁移为已完成
This commit is contained in:
+7
-5
@@ -1,8 +1,8 @@
|
||||
# ReadSDK 代码规范
|
||||
# ReadViewSDK 代码规范
|
||||
|
||||
## 适用范围
|
||||
|
||||
本文档适用于 `ReadSDK` 新增代码与重构代码。
|
||||
本文档适用于 `ReadViewSDK` 新增代码与重构代码。
|
||||
|
||||
- 规范覆盖 `Sources/` 与 `RDReaderDemo/` 中的 Swift 代码。
|
||||
- 命名、分层与职责边界以 SDK 可维护性和可扩展性为优先。
|
||||
@@ -225,15 +225,17 @@ RDEPUBWebView+Reflowable.swift
|
||||
- 命名先定前缀再落代码:类型一律 `RD` 开头。
|
||||
- 若需迁移历史 `SS` 前缀,按模块渐进替换,优先替换新增与重构触达文件。
|
||||
|
||||
## 旧 SS 命名迁移到 RD 的分阶段执行清单
|
||||
## 旧 SS 命名迁移到 RD 的执行状态
|
||||
|
||||
### 阶段 0:冻结新增 SS 命名(立即执行)
|
||||
**迁移已完成**:源码中已无 `SS` 前缀类型定义,全部使用 `RD`/`RDEPUB` 前缀。新增代码必须继续遵守此规则。
|
||||
|
||||
### 阶段 0:冻结新增 SS 命名(已完成)
|
||||
|
||||
- 目标:从当前时点开始,不再引入新的 `SS`/`RDEPUB` 类型名。
|
||||
- 动作:
|
||||
- 新增类型统一使用 `RD`/`RDEPUB` 前缀。
|
||||
- Code Review 增加命名检查项:发现新增 `SS` 命名必须驳回。
|
||||
- 在 PR 模板中加入“本次是否新增旧前缀命名”勾选项。
|
||||
- 在 PR 模板中加入”本次是否新增旧前缀命名”勾选项。
|
||||
- 验收:
|
||||
- 新提交代码中,新增类型 `SS` 前缀数量为 `0`。
|
||||
|
||||
|
||||
Reference in New Issue
Block a user