948004eed1
源码注释： - 为 ~60 个 Swift 文件补充缺失的 doc comment（file header、类型、属性、方法） - 修正 4 处错误注释：翻页模式数量、搜索行为描述、手势识别器描述、悬空文档块 文档维护： - 删除重复文档：WXRead/读书EPUB阅读器实现架构.md（与微信读书版完全一致） - 合并重叠文档：阅读器规划.md → 阅读器功能开发计划.md（单一真值） - 修正过时内容：所有文档中"四种翻页模式"→"三种"，移除 horizontalCoverScroll - 更新架构图：补齐 EPUBUI/ReaderController、Paging/、Typesetter/ 等子目录 - 更新 index.md 索引：新增开发计划和架构对比文档引用
38 lines
3.3 KiB
Markdown
38 lines
3.3 KiB
Markdown
# ReadViewSDK 文档索引
|
||
|
||
## 架构与规范
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [ARCHITECTURE.md](ARCHITECTURE.md) | 四层架构总览（EPUBCore → EPUBTextRendering → RDReaderView → EPUBUI）、数据流、分页模式、位置模型、已知限制 |
|
||
| [CODING_STYLE.md](CODING_STYLE.md) | 命名规范（RD/RDEPUB 前缀）、分层规则、UI 布局规范、代码风格细则、extension 拆分、SS→RD 迁移计划 |
|
||
| [EPUB_MAINTENANCE.md](EPUB_MAINTENANCE.md) | 文件职责表、DTCoreText 渲染管线、常见排查场景、推荐日志断点、阅读器后续能力规划 |
|
||
|
||
## 模块功能实现逻辑
|
||
|
||
| 文档 | 对应模块 | 说明 |
|
||
|------|----------|------|
|
||
| [EPUBCore_功能实现逻辑.md](EPUBCore_功能实现逻辑.md) | `Sources/RDReaderView/EPUBCore/`（31 Swift + 2 资源） | EPUB 解析全流程（ZIP→container.xml→OPF→spine/TOC）、阅读会话状态机、离屏分页测量、`ss-reader://` 资源协议、JS 桥接（6 种消息）、WebView 渲染管线、文本锚点定位、渲染请求模型、缓存策略 |
|
||
| [EPUBTextRendering_功能实现逻辑.md](EPUBTextRendering_功能实现逻辑.md) | `Sources/RDReaderView/EPUBTextRendering/`（13 文件） | DTCoreText HTML→NSAttributedString 渲染管线、片段标记注入/提取、CoreText 分页引擎（含语义边界调整）、文本索引表、Location↔PageNumber 双向转换、分页缓存、性能采样、全文搜索引擎、纯文本构建器 |
|
||
| [RDReaderView_功能实现逻辑.md](RDReaderView_功能实现逻辑.md) | `Sources/RDReaderView/ReaderView/`（5 文件） | 三种显示模式（pageCurl/horizontalScroll/verticalScroll）、DataSource/Delegate 协议、点击三区域翻页、工具栏动画、双页配对与哨兵页、横竖屏适配、RTL 支持 |
|
||
| [EPUBUI_功能实现逻辑.md](EPUBUI_功能实现逻辑.md) | `Sources/RDReaderView/EPUBUI/`（19 文件） | RDEPUBReaderController 全生命周期、三条渲染路径分发、配置变更检测与响应、工具栏/目录/高亮/书签/搜索/设置面板交互流、阅读位置持久化、主题管理、CoreText 页面交互 |
|
||
|
||
## 方案讨论与规划文档
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [阅读器功能开发计划.md](阅读器功能开发计划.md) | 渲染质量三方对比（ReadViewSDK vs WXRead）、功能开发计划与落地状态、优先级路线图 |
|
||
| [架构对比分析_WXRead_vs_ReadViewSDK.md](架构对比分析_WXRead_vs_ReadViewSDK.md) | ReadViewSDK 与 WXRead 的逐项架构核查，确认主链路复刻完成度 |
|
||
| [ReflowableEPUB_WXReadRenderer_Design.md](FeatureSolution/ReflowableEPUB_WXReadRenderer_Design.md) | 基于读书的 CoreText 渲染架构，设计 Reflowable EPUB 的增强文本渲染方案（CSS 分层、类型器升级） |
|
||
|
||
## 测试与质量
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [UI自动化测试工作文档.md](UI自动化测试工作文档.md) | XCUITest UI 自动化测试完整工作计划：现状分析、accessibilityIdentifier 补充清单、UI Test Target 创建、测试用例设计（书库/阅读器/工具栏/设置/书签/高亮/目录/截图）、CI 集成方案、实施检查清单 |
|
||
|
||
## 目录约定
|
||
|
||
- `Doc/`：项目级文档（架构、规范、维护指南、模块实现逻辑）
|
||
- `Doc/FeatureSolution/`：方案讨论文档（由 `discuss-sdk-feature-solution` skill 生成）
|