mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-03-22 10:34:30 +08:00
docs(source-generators): 更新文档结构并调整Godot版本信息
- 将Source Generators概述文档从overview重命名为index - 更新所有相关文档中的链接指向新的index文件 - 移除Godot文档中的许可证和版本信息冗余内容 - 统一Godot版本要求从4.5.1+到4.6 - 删除各模块文档末尾的相关链接部分 - 优化文档结构提升可读性
This commit is contained in:
GeWuYou
parent
3d656981b4
commit
1ab615db26
@ -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 模块版本保持同步
|
||||
@ -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 窗口管理
|
||||
```
|
||||
@ -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 信号系统基础
|
||||
```
|
||||
@ -272,10 +272,4 @@ catch (Exception ex)
|
||||
|
||||
4. **序列化器选择**
|
||||
- JSON：人类可读，调试友好
|
||||
- 二进制：性能更好，文件更小
|
||||
|
||||
## 相关链接
|
||||
|
||||
- [路径扩展](../extensions/README.md#godotpathextensions)
|
||||
- [设置系统](../setting/README.md)
|
||||
- [抽象接口定义](../../../GFramework.Core/Abstractions/storage/)
|
||||
- 二进制：性能更好，文件更小
|
||||
@ -168,6 +168,6 @@ public enum Difficulty
|
||||
|
||||
**相关文档**：
|
||||
|
||||
- [Source Generators 概述](./overview)
|
||||
- [Source Generators 概述](./index)
|
||||
- [日志生成器](./logging-generator)
|
||||
- [规则生成器](./rule-generator)
|
||||
|
||||
@ -49,31 +49,33 @@ GFramework.SourceGenerators 利用 Roslyn 源代码生成器技术，在编译
|
||||
### NuGet 包安装
|
||||
|
||||
```xml
|
||||
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
<PropertyGroup>
|
||||
<TargetFramework>net6.0</TargetFramework>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="GeWuYou.GFramework.SourceGenerators" Version="1.0.0" />
|
||||
<PackageReference Include="GeWuYou.GFramework.SourceGenerators.Attributes" Version="1.0.0" />
|
||||
</ItemGroup>
|
||||
<PropertyGroup>
|
||||
<TargetFramework>net6.0</TargetFramework>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="GeWuYou.GFramework.SourceGenerators" Version="1.0.0"/>
|
||||
<PackageReference Include="GeWuYou.GFramework.SourceGenerators.Attributes" Version="1.0.0"/>
|
||||
</ItemGroup>
|
||||
</Project>
|
||||
```
|
||||
|
||||
### 项目文件配置
|
||||
|
||||
```xml
|
||||
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
<PropertyGroup>
|
||||
<TargetFramework>net6.0</TargetFramework>
|
||||
<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
|
||||
<CompilerGeneratedFilesOutputPath>Generated</CompilerGeneratedFilesOutputPath>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<Compile Remove="$(CompilerGeneratedFilesOutputPath)/**/*.cs" />
|
||||
</ItemGroup>
|
||||
<PropertyGroup>
|
||||
<TargetFramework>net6.0</TargetFramework>
|
||||
<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
|
||||
<CompilerGeneratedFilesOutputPath>Generated</CompilerGeneratedFilesOutputPath>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<Compile Remove="$(CompilerGeneratedFilesOutputPath)/**/*.cs"/>
|
||||
</ItemGroup>
|
||||
</Project>
|
||||
```
|
||||
|
||||
@ -916,8 +918,9 @@ public class MyClass { } // ❌ 编译错误，无法添加生成代码
|
||||
**A**: 生成的代码在编译过程中创建，默认位置在 `obj/Debug/net6.0/generated/` 目录下。可以在项目文件中配置输出位置：
|
||||
|
||||
```xml
|
||||
|
||||
<PropertyGroup>
|
||||
<CompilerGeneratedFilesOutputPath>Generated</CompilerGeneratedFilesOutputPath>
|
||||
<CompilerGeneratedFilesOutputPath>Generated</CompilerGeneratedFilesOutputPath>
|
||||
</PropertyGroup>
|
||||
```
|
||||
|
||||
@ -930,8 +933,9 @@ public class MyClass { } // ❌ 编译错误，无法添加生成代码
|
||||
3. **启用详细日志**：在项目文件中添加：
|
||||
|
||||
```xml
|
||||
|
||||
<PropertyGroup>
|
||||
<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
|
||||
<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
|
||||
</PropertyGroup>
|
||||
```
|
||||
|
||||
@ -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
|
||||
- **Roslyn**: 4.0+
|
||||
@ -155,6 +155,6 @@ public partial class MyClass
|
||||
|
||||
**相关文档**：
|
||||
|
||||
- [Source Generators 概述](./overview)
|
||||
- [Source Generators 概述](./index)
|
||||
- [枚举扩展生成器](./enum-generator)
|
||||
- [规则生成器](./rule-generator)
|
||||
|
||||
@ -158,6 +158,6 @@ public RuleResult Validate(Player player)
|
||||
|
||||
**相关文档**：
|
||||
|
||||
- [Source Generators 概述](./overview)
|
||||
- [Source Generators 概述](./index)
|
||||
- [日志生成器](./logging-generator)
|
||||
- [枚举扩展生成器](./enum-generator)
|
||||
|
||||
@ -433,12 +433,4 @@ dotnet test
|
||||
2. **完善 UI 系统**：创建菜单、HUD、游戏结束界面
|
||||
3. **添加音效系统**：背景音乐、音效播放
|
||||
4. **实现存档功能**：游戏进度保存和加载
|
||||
5. **优化性能**：使用对象池、减少内存分配
|
||||
|
||||
### 学习资源
|
||||
|
||||
- [GFramework 主文档](../)
|
||||
- [Core 模块文档](../core)
|
||||
- [Godot 集成文档](../godot/)
|
||||
|
||||
享受游戏开发的乐趣吧！🎮
|
||||
5. **优化性能**：使用对象池、减少内存分配
|
||||
@ -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
|
||||
5. **发布游戏**：在各个平台发布你的作品
|
||||
Loading…
x
Reference in New Issue
Block a user