mirror of https://github.com/GeWuYou/GFramework.git synced 2026-05-07 00:39:00 +08:00

gewuyou b96565ffa3 docs(documentation): 扩展项目功能文档覆盖

- 更新 meta-package 与安装入口，明确聚合范围、当前运行时基线和首页选包路径
- 补充 Game 配置工具文档与导航，把 VS Code config workflow 纳入 reader-facing 采用链路
- 修正文档与实现不一致的 source-generator 与 CQRS 契约说明，补充 support module 边界
- 记录 RP-038 批处理恢复点、委派结论和本轮验证结果

2026-04-25 17:10:37 +08:00

5.8 KiB

Raw Blame History

title, description

title	description
API 参考	GFramework 的 API 阅读入口，按模块映射 README、专题页、XML 文档和教程链路。

API 参考

这里不再维护一份脱离源码演化的“伪 API 列表”。

当前 GFramework 的 API 参考链路以四类证据协同为准：

模块 README：说明包关系、最小接入路径和目录边界
docs/zh-CN 专题页：说明采用顺序、生命周期和使用建议
代码中的 XML 文档：说明公开 / 内部类型和关键成员的契约
教程页：说明这些 API 在真实接入路径中的组合方式

阅读顺序

想确认“该装哪个包、先看哪类 API”

先读模块 README，再读对应栏目入口页：

入门入口：入门指南
根模块地图：仓库总览

想确认“这个功能属于哪个模块”

按下面的模块映射进入对应入口：

模块族	模块 README	站内入口	XML 文档关注点
`Core` / `Core.Abstractions`	Core 运行时说明、Core 抽象层说明	Core 栏目、Core 抽象层说明	架构入口、生命周期、命令 / 查询 / 事件 / 状态 / 资源 / 日志 / 配置 / 并发契约
`Cqrs` / `Cqrs.Abstractions` / `Cqrs.SourceGenerators`	CQRS 运行时说明、CQRS 抽象层说明、CQRS 源码生成器说明	CQRS 栏目、CQRS Handler Registry 生成器	request / notification / handler / pipeline / registry / fallback contract
`Game` / `Game.Abstractions` / `Game.SourceGenerators`	Game 运行时说明、Game 抽象层说明、Game 源码生成器说明	Game 模块总览、Game 抽象层说明	配置、数据、设置、场景、UI、存储、序列化契约
`Godot` / `Godot.SourceGenerators`	Godot 运行时说明、Godot 源码生成器说明	Godot 模块总览、Godot 项目生成器、GetNode 生成器、BindNodeSignal 生成器	节点扩展、场景 / UI 适配、配置 / 存储 / 设置接线、Godot 生成器入口
`Ecs.Arch` / `Ecs.Arch.Abstractions`	Ecs.Arch 运行时说明、ECS 抽象层说明	ECS 模块总览、Arch ECS 集成、Ecs.Arch 抽象层说明	ECS 模块契约、系统适配、配置对象和运行时装配边界

先看 XML，还是先看教程

先看 XML 文档的情况

你在确认公开类型的约束、线程 / 生命周期语义、参数和返回值契约
你需要区分“抽象层保证了什么”和“默认实现额外提供了什么”
你在做多模块拆分、测试替身或扩展适配层

优先关注这些类型族：

架构 / 模块 / 服务入口
生命周期、注册、路由、工厂、provider 契约
Source Generator 的 attribute、diagnostic 和 generated contract

先看教程和专题页的情况

你要的是最小接入路径，而不是逐个类型展开阅读
你想确认模块组合方式、目录约定和推荐接线顺序
你在做从旧入口迁移到新入口的采用决策

优先入口：

教程概览：教程总览
最佳实践：最佳实践
故障排查：故障排查

当前边界

GFramework.Core.SourceGenerators.Abstractions
GFramework.Godot.SourceGenerators.Abstractions
GFramework.SourceGenerators.Common

这些目录当前不是独立消费模块，因此不单独维护站内 API 参考入口。它们的公开说明跟随所属模块 README 和 source-generators 栏目维护。

更准确地说：

*.SourceGenerators.Abstractions
- 主要定义公开 attribute 和最小契约，供对应生成器与消费端项目共享。
GFramework.SourceGenerators.Common
- 主要提供共享生成器基类、通用 diagnostics，以及生成方法冲突等跨模块约束。

如果你在 Core、CQRS、Game、Godot 的生成器页面里遇到相似的 diagnostics 或冲突语义，优先把它理解为共享支撑层在复用同一套规则，而不是把这些目录当成新的安装入口。

使用方式

把本页当成“API 阅读导航”而不是“签名快照”：

先选模块
再进 README 和专题页确认采用路径
最后回到代码里的 XML 文档核对具体契约

当 README、专题页和 XML 文档出现冲突时，以源码和测试所反映的当前实现为准。

5.8 KiB Raw Blame History Unescape Escape