--- name: generate-module-code-style-doc description: 基于真实源码生成或更新 ReadViewSDK 指定模块的代码组织、命名、分层、UI、状态、缓存和复用规范,适用于 EPUBCore、EPUBTextRendering、ReaderView、EPUBUI、RDPDFReaderView 或 Demo。全局规范使用 generate-sdk-code-style-doc。 --- # 生成模块代码规范 ## 工作流 1. 确定目标模块、关注范围和输出文件;优先增量更新 `Doc/` 中现有对应文档。 2. 读取目标模块源码、对应 code reference、`Doc/CONVENTIONS.md` 和必要架构章节。 3. 抽样入口、协议、模型、View/Cell、Controller、Coordinator/Service、缓存和 Extension;不存在的层级不要补造。 4. 提炼真实且重复出现的模式,并区分当前约定、特殊例外及原因、尚未落地的建议。 5. 记录目录职责、命名、可见性、依赖方向、状态管理、布局、回调、缓存、失败处理、公共 API 和跨模块边界。 6. 对 EPUB 模块说明适用的渲染路径;对 PDF 模块说明自定义 Provider 与 PDFKit 路径差异。 7. 增量更新文档,检查与全局规范、podspec、架构和源码是否冲突。 8. 文档新增、移动或重命名时同步 `Doc/index.md`。 ## 边界 - 只描述目标模块,不把局部模式提升为全局事实。 - 不虚构理想分层、协议或不存在的调用链。 - 默认不修改业务代码;发现问题时作为建议或 finding 单独列出。