mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-06 16:16:44 +08:00
- 调整文档真实性原则,以源码和测试为首要证据源 - 新增模块README要求,规定所有用户包必须有说明文档 - 更新仓库文档规范,要求根README与文档站点分类一致 - 添加VitePress配置文件,支持中文搜索和泛型转义 - 创建入门指南文档,说明GFramework模块组成和接入路径 - 添加快速开始教程,演示Core模块最小使用示例 - 为Core模块添加详细README文档 - 为Core.Abstractions添加契约层说明文档 - 为Core.SourceGenerators添加源码生成器文档 - 为Game模块添加运行时层详细说明文档
917 B
917 B
抽象接口
GFramework.*.Abstractions 用来承载跨模块协作所需的契约,而不是运行时实现。
适合阅读这部分内容的场景:
- 你要做模块拆分,只想依赖接口,不想直接引用完整运行时
- 你要为测试、编辑器工具或插件提供替身实现
- 你在维护生成器、适配层或二次封装,需要先理解契约边界
阅读顺序
- Core 抽象层:
core-abstractions.md - Game 抽象层:
game-abstractions.md
使用建议
- 如果你只是想直接使用框架功能,优先从对应运行时模块的
README.md和栏目页开始。 - 只有在明确需要“契约层而非实现层”时,才单独依赖
*.Abstractions包。 - 抽象层页面会解释接口分组与职责;真正的安装和采用路径,仍应以运行时模块 README 与
getting-started为主。