From 1ab615db26cc57d44260e06d7c8de8165674be4e Mon Sep 17 00:00:00 2001 From: GeWuYou <95328647+GeWuYou@users.noreply.github.com> Date: Wed, 11 Feb 2026 15:57:40 +0800 Subject: [PATCH] =?UTF-8?q?docs(source-generators):=20=E6=9B=B4=E6=96=B0?= =?UTF-8?q?=E6=96=87=E6=A1=A3=E7=BB=93=E6=9E=84=E5=B9=B6=E8=B0=83=E6=95=B4?= =?UTF-8?q?Godot=E7=89=88=E6=9C=AC=E4=BF=A1=E6=81=AF?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 将Source Generators概述文档从overview重命名为index - 更新所有相关文档中的链接指向新的index文件 - 移除Godot文档中的许可证和版本信息冗余内容 - 统一Godot版本要求从4.5.1+到4.6 - 删除各模块文档末尾的相关链接部分 - 优化文档结构提升可读性 --- docs/zh-CN/godot/index.md | 13 +---- docs/zh-CN/godot/setting.md | 10 +--- docs/zh-CN/godot/signal.md | 9 +--- docs/zh-CN/godot/storage.md | 8 +-- .../zh-CN/source-generators/enum-generator.md | 2 +- .../{overview.md => index.md} | 53 +++++++++---------- .../source-generators/logging-generator.md | 2 +- .../zh-CN/source-generators/rule-generator.md | 2 +- docs/zh-CN/tutorials/basic-tutorial.md | 10 +--- docs/zh-CN/tutorials/getting-started.md | 16 +----- 10 files changed, 34 insertions(+), 91 deletions(-) rename docs/zh-CN/source-generators/{overview.md => index.md} (96%) diff --git a/docs/zh-CN/godot/index.md b/docs/zh-CN/godot/index.md index 0333c83..1311f94 100644 --- a/docs/zh-CN/godot/index.md +++ b/docs/zh-CN/godot/index.md @@ -894,15 +894,6 @@ graph TD ## 版本兼容性 -- **Godot**: 4.5.1+ +- **Godot**: 4.6 - **.NET**: 6.0+ -- **GFramework.Core**: 与 Core 模块版本保持同步 - -## 许可证 - -本项目基于 Apache 2.0 许可证 - 详情请参阅 [LICENSE](../LICENSE) 文件。 - ---- - -**版本**: 1.0.0 -**更新日期**: 2026-01-12 +- **GFramework.Core**: 与 Core 模块版本保持同步 \ No newline at end of file diff --git a/docs/zh-CN/godot/setting.md b/docs/zh-CN/godot/setting.md index c4c9a59..385512a 100644 --- a/docs/zh-CN/godot/setting.md +++ b/docs/zh-CN/godot/setting.md @@ -568,12 +568,4 @@ var windowMode = DisplayServer.WindowGetMode(); GD.Print($"Screen: {screenSize}"); GD.Print($"Window: {windowSize} at {windowPos}"); GD.Print($"Mode: {windowMode}"); -``` - -## 相关链接 - -- [设置系统](../../GFramework.Game/setting/README.md) - 通用设置框架 -- [存储模块](../storage/README.md) - 设置持久化存储 -- [扩展方法](../extensions/README.md) - Godot 扩展功能 -- [Godot 音频文档](https://docs.godotengine.org/en/stable/tutorials/audio/audio_buses.html) - Godot 音频总线系统 -- [Godot 显示文档](https://docs.godotengine.org/en/stable/tutorials/rendering/window_management.html) - Godot 窗口管理 \ No newline at end of file +``` \ No newline at end of file diff --git a/docs/zh-CN/godot/signal.md b/docs/zh-CN/godot/signal.md index f0d07c5..36b66f0 100644 --- a/docs/zh-CN/godot/signal.md +++ b/docs/zh-CN/godot/signal.md @@ -417,11 +417,4 @@ player.Signal(Player.SignalName.HealthChanged) // ❌ 避免：过度嵌套 node.Signal(CustomSignal.Signal1).WithFlags(Flags1).To(callable1) .Signal(CustomSignal.Signal2).WithFlags(Flags2).To(callable2); -``` - -## 相关链接 - -- [Godot 扩展方法](../README.md) - 扩展方法总览 -- [节点扩展](../README.md#nodeextensions) - 更多节点操作方法 -- [取消注册扩展](../README.md#unregisterextension) - 事件生命周期管理 -- [Godot 官方信号文档](https://docs.godotengine.org/en/stable/tutorials/scripting_signals.html) - Godot 信号系统基础 \ No newline at end of file +``` \ No newline at end of file diff --git a/docs/zh-CN/godot/storage.md b/docs/zh-CN/godot/storage.md index 6173646..32590c3 100644 --- a/docs/zh-CN/godot/storage.md +++ b/docs/zh-CN/godot/storage.md @@ -272,10 +272,4 @@ catch (Exception ex) 4. **序列化器选择** - JSON：人类可读，调试友好 - - 二进制：性能更好，文件更小 - -## 相关链接 - -- [路径扩展](../extensions/README.md#godotpathextensions) -- [设置系统](../setting/README.md) -- [抽象接口定义](../../../GFramework.Core/Abstractions/storage/) \ No newline at end of file + - 二进制：性能更好，文件更小 \ No newline at end of file diff --git a/docs/zh-CN/source-generators/enum-generator.md b/docs/zh-CN/source-generators/enum-generator.md index 333fc5e..a9a98f0 100644 --- a/docs/zh-CN/source-generators/enum-generator.md +++ b/docs/zh-CN/source-generators/enum-generator.md @@ -168,6 +168,6 @@ public enum Difficulty **相关文档**： -- [Source Generators 概述](./overview) +- [Source Generators 概述](./index) - [日志生成器](./logging-generator) - [规则生成器](./rule-generator) diff --git a/docs/zh-CN/source-generators/overview.md b/docs/zh-CN/source-generators/index.md similarity index 96% rename from docs/zh-CN/source-generators/overview.md rename to docs/zh-CN/source-generators/index.md index a1180a4..1f8ebf7 100644 --- a/docs/zh-CN/source-generators/overview.md +++ b/docs/zh-CN/source-generators/index.md @@ -49,31 +49,33 @@ GFramework.SourceGenerators 利用 Roslyn 源代码生成器技术，在编译 ### NuGet 包安装 ```xml + - - net6.0 - - - - - - + + net6.0 + + + + + + ``` ### 项目文件配置 ```xml + - - net6.0 - true - Generated - - - - - + + net6.0 + true + Generated + + + + + ``` @@ -916,8 +918,9 @@ public class MyClass { } // ❌ 编译错误，无法添加生成代码 **A**: 生成的代码在编译过程中创建，默认位置在 `obj/Debug/net6.0/generated/` 目录下。可以在项目文件中配置输出位置： ```xml + - Generated + Generated ``` @@ -930,8 +933,9 @@ public class MyClass { } // ❌ 编译错误，无法添加生成代码 3. **启用详细日志**：在项目文件中添加： ```xml + - true + true ``` @@ -985,13 +989,4 @@ graph TD - **.NET**: 6.0+ - **Visual Studio**: 2022 17.0+ - **Rider**: 2022.3+ -- **Roslyn**: 4.0+ - -## 许可证 - -本项目基于 Apache 2.0 许可证 - 详情请参阅 [LICENSE](../LICENSE) 文件。 - ---- - -**版本**: 1.0.0 -**更新日期**: 2026-01-12 \ No newline at end of file +- **Roslyn**: 4.0+ \ No newline at end of file diff --git a/docs/zh-CN/source-generators/logging-generator.md b/docs/zh-CN/source-generators/logging-generator.md index e02dd8a..0caf9d7 100644 --- a/docs/zh-CN/source-generators/logging-generator.md +++ b/docs/zh-CN/source-generators/logging-generator.md @@ -155,6 +155,6 @@ public partial class MyClass **相关文档**： -- [Source Generators 概述](./overview) +- [Source Generators 概述](./index) - [枚举扩展生成器](./enum-generator) - [规则生成器](./rule-generator) diff --git a/docs/zh-CN/source-generators/rule-generator.md b/docs/zh-CN/source-generators/rule-generator.md index fcbe1db..9776632 100644 --- a/docs/zh-CN/source-generators/rule-generator.md +++ b/docs/zh-CN/source-generators/rule-generator.md @@ -158,6 +158,6 @@ public RuleResult Validate(Player player) **相关文档**： -- [Source Generators 概述](./overview) +- [Source Generators 概述](./index) - [日志生成器](./logging-generator) - [枚举扩展生成器](./enum-generator) diff --git a/docs/zh-CN/tutorials/basic-tutorial.md b/docs/zh-CN/tutorials/basic-tutorial.md index 3c6fca0..b2d10e3 100644 --- a/docs/zh-CN/tutorials/basic-tutorial.md +++ b/docs/zh-CN/tutorials/basic-tutorial.md @@ -433,12 +433,4 @@ dotnet test 2. **完善 UI 系统**：创建菜单、HUD、游戏结束界面 3. **添加音效系统**：背景音乐、音效播放 4. **实现存档功能**：游戏进度保存和加载 -5. **优化性能**：使用对象池、减少内存分配 - -### 学习资源 - -- [GFramework 主文档](../) -- [Core 模块文档](../core) -- [Godot 集成文档](../godot/) - -享受游戏开发的乐趣吧！🎮 \ No newline at end of file +5. **优化性能**：使用对象池、减少内存分配 \ No newline at end of file diff --git a/docs/zh-CN/tutorials/getting-started.md b/docs/zh-CN/tutorials/getting-started.md index c0b248b..ecb4de5 100644 --- a/docs/zh-CN/tutorials/getting-started.md +++ b/docs/zh-CN/tutorials/getting-started.md @@ -1607,18 +1607,4 @@ namespace MyGFrameworkGame.Core.Systems 2. **优化性能**：使用对象池、减少内存分配 3. **添加网络功能**：多人游戏、排行榜 4. **完善 UI**：更丰富的界面和动画 -5. **发布游戏**：在各个平台发布你的作品 - -### 学习资源 - -- [GFramework 主文档](../../README.md) -- [GFramework.Core 文档](../../GFramework.Core/README.md) -- [GFramework.Godot 文档](../../GFramework.Godot/README.md) -- [GFramework.SourceGenerators 文档](../../GFramework.SourceGenerators/README.md) - -享受游戏开发的乐趣吧！🎮 - ---- - -**教程版本**: 1.0.0 -**更新日期**: 2026-01-12 \ No newline at end of file +5. **发布游戏**：在各个平台发布你的作品 \ No newline at end of file