-示例：类/结构体
+💻 完整代码示例：类绑定
-
+
-```cpp
+```cpp title="FTestBindingFunction.h"
#pragma once
+// 普通的 C++ 类，未使用 UE 反射
class FTestBindingFunction
{
public:
- FTestBindingFunction();
+ FTestBindingFunction();
public:
- void SetInt32ValueFunction(int32 InInt32Value);
+ // 设置整型值
+ void SetInt32ValueFunction(int32 InInt32Value);
- int32 GetInt32ValueFunction() const;
+ // 获取整型值
+ int32 GetInt32ValueFunction() const;
- void OutInt32ValueFunction(int32& OutInt32Value) const;
+ // 输出参数示例
+ void OutInt32ValueFunction(int32& OutInt32Value) const;
public:
- int32 Int32Value;
+ int32 Int32Value;
};
```
+
+ ⚠️ 限制： 普通 C++ 类无法被 UE 反射系统识别，C# 无法直接访问
+
+
-
+
+
+```cpp title="FTestBindingFunctionBinding.cpp"
+#include "FTestBindingFunction.h"
-```cpp
+// 声明这是一个需要绑定的类
BINDING_CLASS(FTestBindingFunction)
struct FRegisterTestBindingFunction
{
- FRegisterTestBindingFunction()
- {
- TBindingClassBuilder(NAMESPACE_BINDING)
- .Property("Int32Value", BINDING_PROPERTY(&FTestBindingFunction::Int32Value))
- .Function("SetInt32ValueFunction", BINDING_FUNCTION(&FTestBindingFunction::SetInt32ValueFunction))
- .Function("GetInt32ValueFunction", BINDING_FUNCTION(&FTestBindingFunction::GetInt32ValueFunction))
- .Function("OutInt32ValueFunction", BINDING_FUNCTION(&FTestBindingFunction::OutInt32ValueFunction));
- }
+ FRegisterTestBindingFunction()
+ {
+ // 使用 TBindingClassBuilder 进行绑定
+ TBindingClassBuilder(NAMESPACE_BINDING)
+ // 绑定属性
+ .Property("Int32Value",
+ BINDING_PROPERTY(&FTestBindingFunction::Int32Value))
+
+ // 绑定成员函数
+ .Function("SetInt32ValueFunction",
+ BINDING_FUNCTION(&FTestBindingFunction::SetInt32ValueFunction))
+ .Function("GetInt32ValueFunction",
+ BINDING_FUNCTION(&FTestBindingFunction::GetInt32ValueFunction))
+ .Function("OutInt32ValueFunction",
+ BINDING_FUNCTION(&FTestBindingFunction::OutInt32ValueFunction));
+ }
};
+// 静态注册实例
static FRegisterTestBindingFunction RegisterTestBindingFunction;
```
+
+ 🎉 成功： 现在 C# 可以完全访问这个类的所有功能！
+
+
+
+
+
+
+```csharp title="Usage.cs"
+// 在 C# 中使用绑定的类
+public class ExampleUsage
+{
+ public void UseBindingClass()
+ {
+ // 创建实例
+ var testObj = new FTestBindingFunction();
+
+ // 直接访问属性
+ testObj.Int32Value = 42;
+ int currentValue = testObj.Int32Value;
+
+ // 调用成员函数
+ testObj.SetInt32ValueFunction(100);
+ int getValue = testObj.GetInt32ValueFunction();
+
+ // 使用输出参数
+ int outValue;
+ testObj.OutInt32ValueFunction(out outValue);
+
+ Console.WriteLine($"当前值: {outValue}");
+ }
+}
+```
+
+
+
+
+
+```cpp title="AdvancedBinding.cpp"
+// 高级绑定功能示例
+BINDING_CLASS(FAdvancedClass)
+
+struct FRegisterAdvancedClass
+{
+ FRegisterAdvancedClass()
+ {
+ TBindingClassBuilder(NAMESPACE_BINDING)
+ // 绑定构造函数
+ .Constructor()
+
+ // 绑定静态变量
+ .StaticProperty("StaticValue",
+ BINDING_STATIC_PROPERTY(&FAdvancedClass::StaticValue))
+
+ // 绑定操作符重载
+ .Operator("+", BINDING_OPERATOR(&FAdvancedClass::operator+))
+ .Operator("==", BINDING_OPERATOR(&FAdvancedClass::operator==))
+
+ // 绑定下标运算符
+ .Operator("[]", BINDING_OPERATOR(&FAdvancedClass::operator[]))
+
+ // 绑定重载函数
+ .Function("Process",
+ BINDING_OVERLOAD(void, FAdvancedClass, (int32), &FAdvancedClass::Process))
+ .Function("Process",
+ BINDING_OVERLOAD(void, FAdvancedClass, (float, bool), &FAdvancedClass::Process));
+ }
+};
+```
+
@@ -136,28 +353,306 @@ static FRegisterTestBindingFunction RegisterTestBindingFunction;
---
-## 通过UHT生成
-
-通过UHT，根据[配置](../guides/configuration/editor)的模块或者插件，自动生成静态绑定代码。
+## 🤖 通过 UHT 自动生成
+
+
+ 🚀 自动化流程： UnrealCSharp 可以通过 UHT (Unreal Header Tool) 根据配置自动生成静态绑定代码，大大减少手工编写的工作量。
+
+
+### 📋 配置步骤
+
+1. **配置模块/插件** - 在[编辑器配置](../guides/configuration/editor)中指定需要生成绑定的模块或插件
+2. **运行 UHT** - UHT 会扫描指定的头文件
+3. **自动生成** - 生成对应的静态绑定代码文件
+4. **引用文件** - 在项目中引用生成的绑定文件
+
+### 💡 优势对比
+
+
+
+
+
+
✍️ 手动绑定
+
+
+
+ - 🎯 精确控制绑定内容
+ - 🔧 自定义绑定逻辑
+ - ⚠️ 工作量大，易出错
+ - 🔄 维护成本高
+
+
+
+
+
+
+
+
🤖 自动生成
+
+
+
+ - ⚡ 快速批量生成
+ - ✅ 减少人为错误
+ - 🔄 易于维护更新
+ - 📦 覆盖范围广
+
+
+
+
+
-示例：引用静态绑定文件
+💻 代码示例：引用生成的绑定文件
-```cpp
+
+
+
+
+```cpp title="YourModule.cpp"
+// 引用自动生成的静态绑定文件
#if WITH_BINDING
-#include "Binding/Class/PreHeader.h"
-#include "Engine.header.inl"
-#include "UMG.header.inl"
+ #include "Binding/Class/PreHeader.h"
+
+ // 引用 Engine 模块的绑定
+ #include "Engine.header.inl"
+
+ // 引用 UMG 模块的绑定
+ #include "UMG.header.inl"
+
+ // 引用其他模块的绑定
+ #include "YourCustomModule.header.inl"
#endif
```
+
+
💡 说明：
+
+ WITH_BINDING 宏确保只在需要时编译绑定代码PreHeader.h 包含必要的绑定基础设施*.header.inl 文件包含具体的绑定实现
+
---
-## 示例
+## 📚 学习资源与示例
+
+### 🎯 官方示例代码
+
+
+ 📁 示例位置： Source/UnrealCSharp/Private/Domain/InternalCall 目录下包含了大量的绑定示例。
+
+
+
+
+
+
+
🎯 推荐学习示例
+
+
+
+ -
+ [FRegisterVector](https://github.com/crazytuzi/UnrealCSharp/blob/main/Source/UnrealCSharp/Private/Domain/InternalCall/FRegisterVector.cpp) - 向量类型绑定
+
+ - FRegisterRotator - 旋转器绑定
+ - FRegisterTransform - 变换矩阵绑定
+ - FRegisterArray - 数组容器绑定
+
+
+
+
+
+
+
+
🔧 实践建议
+
+
+
+ - 从简单的结构体开始
+ - 先绑定基础功能
+ - 逐步添加高级特性
+ - 参考官方示例代码
+
+
+
+
+
+
🎯 绑定技巧：
+
+ - 命名规范： 保持 C++ 和 C# 命名一致性
+ - 类型安全： 确保参数和返回类型匹配
+ - 内存管理： 注意对象生命周期管理
+ - 性能考虑： 避免频繁的跨语言调用
+
+
+
+ 🎯 革命性功能：纯 C# 创建完整的 UE 类型系统
+
+
+ 🚀 核心特性： 动态类系统允许您通过 C# 代码直接生成 UClass、UInterface、UStruct 和 UEnum，无需任何蓝图载体！
+
+
+### 🎯 支持的类型
+
+
+
+
+
+
📋 基础类型
+
+
+
+ - 🔢 UEnum - 枚举类型
+ - 📦 UStruct - 结构体类型
+
+
+
+
+
+
+
+
🏗️ 高级类型
+
+
+
+ - 🎮 UClass - 游戏对象类
+ - 🔌 UInterface - 接口类型
+
+
+
+
+
+ 🔍 技术细节： 了解动态类的底层工作机制，有助于更好地使用这一强大功能。
+
+
+### 📦 Package 映射机制
+
+在 [反射文档](reflection.md) 中介绍了 C++ Package 和 C# Namespace 的映射关系。对于动态类有特殊处理：
+
+
+
+
+
+
🎯 统一 Package
+
+
+
所有动态类都创建在：
+
/Script/CoreUObject
+
原因：
+
+ - 避免序列化失败
+ - 支持场景放置
+ - 确保引用安全
+
+
+
+
+
+
+
+
🔄 热重载支持
+
+
+
特殊设计：
+
+ - 继承于 OverrideAttribute
+ - 回到反射绑定流程
+ - 支持编辑器热重载
+ - 规范的文件命名
+
+
+
+
+
+ ⚠️ 重要： 动态类必须遵循严格的命名规范，这是确保系统正常工作的关键！
+
+
+| 类型 | 类名前缀 | 文件名前缀 | 示例 |
+|------|----------|------------|------|
+| UEnum | `E` | `E` | `ETestDynamicEnum` |
+| UStruct | `F` | 无 | `FTestDynamicStruct` |
+| UClass | `U` 或 `A` | 无 | `ATestDynamicActor` |
+| UInterface | `I` | 无 | `ITestDynamicInterface` |
---
-## UEnum
+## 🔢 UEnum - 动态枚举
+
+
+ 🎯 蓝图兼容性： 如果需要标记 BlueprintType（被蓝图使用），UnderlyingType 必须设置为 byte。
+
+
+### 📋 创建要求
-如果需要标记BlueprintType，即被蓝图使用，需要将UnderlyingType设置为byte。枚举名和文件名都需要`E`前缀。
+- **类名前缀：** `E` (例如: `ETestDynamicEnum`)
+- **文件名前缀：** `E` (例如: `ETestDynamicEnum.cs`)
+- **蓝图类型：** UnderlyingType 必须为 `byte`
-示例：UEnum
+💻 完整代码示例：动态枚举
-
+
-```csharp
+```csharp title="ETestDynamicEnum.cs"
using Script.Dynamic;
namespace Script.CoreUObject
@@ -49,6 +154,96 @@ namespace Script.CoreUObject
}
```
+
+
✅ 特性说明：
+
+ [UEnum] - 标记为 UE 枚举类型[BlueprintType] - 允许在蓝图中使用: byte - 确保蓝图兼容性
+
+
💡 高级用法：
+
+ - 使用
[DisplayName] 自定义蓝图中的显示名称
+ - 可以设计为位标志枚举
+ - 支持多个枚举在同一文件中
+
+
+ 📝 命名规范： 类名需要 F 前缀，但文件名不需要前缀。
+
-类名需要`F`前缀，文件名不需要`F`前缀。
+### 📋 创建要求
+
+- **类名前缀：** `F` (例如: `FTestDynamicStruct`)
+- **文件名：** 无前缀 (例如: `TestDynamicStruct.cs`)
+- **继承标记：** 必须标记 `partial` 以支持代码生成
-示例：UStruct
+💻 完整代码示例：动态结构体
-
+
-```csharp
+```csharp title="TestDynamicStruct.cs"
using Script.Dynamic;
namespace Script.CoreUObject
@@ -83,6 +286,158 @@ namespace Script.CoreUObject
}
```
+
+
✅ 特性说明：
+
+ [UStruct] - 标记为 UE 结构体[BlueprintType] - 蓝图可用partial - 支持代码生成[UProperty] - 标记属性为 UE 属性
+
+
💡 高级特性：
+
+ [Meta] 特性用于添加编辑器约束Category 用于在蓝图中分组显示- 支持复杂的 UE 类型如
TArray
+ - 可以添加自定义方法（不会暴露给蓝图）
+
+
+ 📝 命名约定： 类名需要 U 或 A 前缀，文件名不需要前缀。动态蓝图类需要以 _C 结尾。
+
+
+### 📋 创建要求
+
+- **Actor 类前缀：** `A` (例如: `ATestDynamicActor`)
+- **Object 类前缀：** `U` (例如: `UTestDynamicComponent`)
+- **文件名：** 无前缀 (例如: `TestDynamicActor.cs`)
+- **蓝图类：** 以 `_C` 结尾 (例如: `AMyGameActor_C`)
-示例：UClass
+💻 完整代码示例：动态游戏类
-
+
-```csharp
+```csharp title="TestDynamicActor.cs"
using Script.Dynamic;
using Script.Engine;
+using Script.CoreUObject;
namespace Script.CoreUObject
{
- [UClass]
- public partial class ATestRawDynamicFunctionActor : AActor, ITestDynamicInterface
+ [UClass, BlueprintType, Blueprintable]
+ public partial class ATestDynamicActor : AActor, ITestDynamicInterface
{
- public ATestRawDynamicFunctionActor()
+ public ATestDynamicActor()
{
+ // 设置默认值
Int32Value = 12;
+ PrimaryActorTick.bCanEverTick = true;
+
+ // 创建默认组件
+ SceneComponent = CreateDefaultSubobject("SceneComponent");
+ RootComponent = SceneComponent;
}
- [UProperty]
+ [UProperty, BlueprintReadWrite, Category = "测试属性"]
public int Int32Value { get; set; }
+
+ [UProperty, BlueprintReadWrite, Category = "组件"]
+ public USceneComponent SceneComponent { get; set; }
- [UFunction]
+ [UFunction, BlueprintCallable, Category = "测试函数"]
public void SetInt32ValueFunction(int InInt32Value)
{
Int32Value = InInt32Value;
}
- [UFunction]
+ [UFunction, BlueprintCallable, BlueprintPure, Category = "测试函数"]
public int GetInt32ValueFunction()
{
return Int32Value;
}
- [UFunction]
+ [UFunction, BlueprintCallable, Category = "测试函数"]
public void OutInt32ValueFunction(ref int OutInt32Value)
{
OutInt32Value = Int32Value;
}
+
+ // 重写 Actor 生命周期函数
+ public override void BeginPlay()
+ {
+ base.BeginPlay();
+ // 游戏开始时的逻辑
+ }
+
+ public override void Tick(float DeltaTime)
+ {
+ base.Tick(DeltaTime);
+ // 每帧更新逻辑
+ }
+ }
+}
+```
+
+
+
✅ 特性说明：
+
+ [UClass] - 标记为 UE 类[BlueprintType] - 可在蓝图中使用作为变量类型[Blueprintable] - 可以创建蓝图子类partial - 支持代码生成
+
+ ⚠️ 限制： 动态接口不支持继承蓝图接口，但可以定义纯 C# 接口供动态类实现。
+
+
+### 📋 创建要求
-不支持继承蓝图接口。接口名需要`I`前缀，文件名不需要`I`前缀。
+- **接口名前缀：** `I` (例如: `ITestDynamicInterface`)
+- **文件名：** 无前缀 (例如: `TestDynamicInterface.cs`)
+- **必须继承：** `IInterface` 基接口
-示例：UInterface
+💻 完整代码示例：动态接口
-
+
-```csharp
+```csharp title="TestDynamicInterface.cs"
using Script.Dynamic;
+using Script.CoreUObject;
namespace Script.CoreUObject
{
[UInterface, Blueprintable]
public interface ITestDynamicInterface : IInterface
{
+ // 接口定义（仅声明，无实现）
+ }
+}
+```
+
+
+
✅ 特性说明：
+
+ [UInterface] - 标记为 UE 接口[Blueprintable] - 允许蓝图实现: IInterface - 必须继承基接口
+
+
+ 🎯 快速搭建您的 UnrealCSharp 开发环境
+
+
+
+
+
+
⚡ .NET 8+ Runtime
+
+
+
+
+
+
+
+
+
+
🚀 JetBrains Rider
+
+
+
推荐指数：⭐⭐⭐⭐⭐
+
+ - 最佳 C# 开发体验
+ - 强大的调试功能
+ - 优秀的 Unreal 支持
+
+
下载
+
+
+
+
+
+
+
💼 Visual Studio
+
+
+
推荐指数：⭐⭐⭐⭐
+
+ - Microsoft 官方 IDE
+ - 完整 .NET 生态支持
+ - 免费 Community 版本
+
+
下载
+
+
+
+
+
+
+
⚡ VS Code
+
+
+
推荐指数：⭐⭐⭐
+
+ - 轻量级编辑器
+ - 丰富的扩展生态
+ - 完全免费开源
+
+
下载
+
+
+
+
+ 💡 推荐理由： 获取最新功能，完整源码控制，便于自定义修改
+
+
+1. **📥 克隆仓库**
+ ```bash
+ git clone --recurse-submodule https://github.com/crazytuzi/UnrealCSharp
+ ```
+
+2. **📁 复制到项目**
+ ```
+ 将整个文件夹复制到：
+ YourProject/
+ └── Plugins/
+ └── UnrealCSharp/
+ ```
+
+3. **✅ 验证安装**
+ - 重新生成项目文件
+ - 编译项目
+ - 启动编辑器
-
+
+
+### 步骤说明
-1. 通过[releases](https://github.com/crazytuzi/UnrealCSharp/releases)下载需要的版本
-2. 下载[Mono](https://github.com/crazytuzi/Mono)和[SourceCodeGenerator](https://github.com/crazytuzi/SourceCodeGenerator)，放到对应目录
-3. 拷贝到`项目`的`Plugins`目录
+
+ 📝 注意： 需要手动下载依赖组件
+
+
+1. **📥 下载发布包**
+ - 访问 [GitHub Releases](https://github.com/crazytuzi/UnrealCSharp/releases)
+ - 选择对应版本下载
+
+2. **📥 下载依赖组件**
+ - [Mono Runtime](https://github.com/crazytuzi/Mono)
+ - [SourceCodeGenerator](https://github.com/crazytuzi/SourceCodeGenerator)
+ - 按照目录结构放置
+
+3. **📁 复制到项目**
+ ```
+ 将整个文件夹复制到：
+ YourProject/
+ └── Plugins/
+ └── UnrealCSharp/
+ ```
@@ -50,24 +176,112 @@ import TabItem from '@theme/TabItem';
---
-## 生成C#工程
+## 🎯 生成 C# 工程
+
+安装完成后，需要生成 C# 项目文件：
-
+
-- 点击`Generator Code`
-- `项目/Script`即为C#工程目录
+### 使用编辑器按钮
+
+
+ 🎯 最简单的方式
+
+
+1. **🔍 找到按钮**
+ - 在 Unreal Editor 工具栏中
+ - 查找 `Generator Code` 按钮
+
+2. **🖱️ 点击生成**
+ - 点击按钮开始生成
+ - 等待生成完成
+
+3. **📁 检查结果**
+ ```
+ YourProject/
+ └── Script/ ← C# 工程目录
+ ├── Game/
+ ├── Engine/
+ └── YourProject.sln
+ ```
-
+
+
+### 使用控制台命令
+
+
+ 🔧 适合高级用户
+
+
+1. **📝 打开控制台**
+ - 在编辑器中按 `` ` `` 键
+ - 或者在 Window → Developer Tools → Output Log
+
+2. **⌨️ 执行命令**
+ ```
+ UnrealCSharp.Editor.Generator
+ ```
-- `UnrealCSharp.Editor.Generator`
-- `项目/Script`即为C#工程目录
+3. **📁 检查结果**
+ - 生成的 C# 工程位于 `项目/Script` 目录
---
+
+## ✅ 验证安装
+
+### 🔍 检查清单
+
+
+
+
+
+
📁 文件结构
+
+
+
+ - ✅ Plugins/UnrealCSharp/ 存在
+ - ✅ Script/ 目录已生成
+ - ✅ 解决方案文件 (.sln) 已创建
+
+
+
+
+
+
+
+
🛠️ 编辑器功能
+
+
+
+ - ✅ Generator Code 按钮可见
+ - ✅ UnrealCSharp 插件已启用
+ - ✅ 控制台命令可用
+
+
+
+
+
+## 📚 完整示例
-示例：覆盖函数
+下面展示了一个完整的函数覆盖示例，包括 C++ 定义和 C# 实现：
-
+
-```cpp
+```cpp title="TestCSharpFunctionActor.h"
#pragma once
#include "CoreMinimal.h"
#include "GameFramework/Actor.h"
#include "TestCSharpFunctionActor.generated.h"
-UCLASS()
+UCLASS(BlueprintType, Blueprintable)
class UNREALCSHARPTEST_API ATestCSharpFunctionActor : public AActor
{
GENERATED_BODY()
@@ -53,45 +71,75 @@ public:
// Sets default values for this actor's properties
ATestCSharpFunctionActor();
+protected:
+ // 私有成员变量，用于存储整数值
+ UPROPERTY(BlueprintReadWrite, Category = "Test Values")
+ int32 Int32Value = 0;
+
public:
- UFUNCTION(BlueprintCallable, BlueprintImplementableEvent)
+ // 🔹 设置整数值的可实现事件
+ UFUNCTION(BlueprintCallable, BlueprintImplementableEvent, Category = "Test Functions")
void SetInt32ValueFunction(int32 InInt32Value);
- UFUNCTION(BlueprintCallable, BlueprintImplementableEvent)
+ // 🔹 获取整数值的可实现事件
+ UFUNCTION(BlueprintCallable, BlueprintImplementableEvent, Category = "Test Functions")
int32 GetInt32ValueFunction() const;
- UFUNCTION(BlueprintCallable, BlueprintImplementableEvent)
+ // 🔹 通过引用输出整数值的可实现事件
+ UFUNCTION(BlueprintCallable, BlueprintImplementableEvent, Category = "Test Functions")
void OutInt32ValueFunction(int32& OutInt32Value) const;
};
```
-
+
-```csharp
+```csharp title="ATestCSharpFunctionActor.Override.cs"
using Script.CoreUObject;
namespace Script.UnrealCSharpTest
{
+ ///
+ /// TestCSharpFunctionActor 的 C# 函数覆盖实现
+ /// 通过 Partial 类机制扩展原有功能
+ ///
[Override]
public partial class ATestCSharpFunctionActor
{
+ ///
+ /// 设置整数值
+ ///
+ /// 要设置的整数值
[Override]
public void SetInt32ValueFunction(int InInt32Value)
{
+ // 🎯 将传入的值赋给内部存储
Int32Value = InInt32Value;
+
+ // 可以在这里添加额外的逻辑
+ // 例如：日志记录、数据验证等
}
+ ///
+ /// 获取当前存储的整数值
+ ///
+ /// 当前的整数值
[Override]
public int GetInt32ValueFunction()
{
+ // 🎯 返回内部存储的值
return Int32Value;
}
+ ///
+ /// 通过引用参数输出整数值
+ ///
+ /// 输出参数，用于接收当前值
[Override]
public void OutInt32ValueFunction(ref int OutInt32Value)
{
+ // 🎯 将内部值赋给输出参数
OutInt32Value = Int32Value;
}
}
@@ -102,11 +150,60 @@ namespace Script.UnrealCSharpTest
-
+:::info 🎯 代码说明
+
+- **`[Override]` 特性**：标记在类和方法上，告知系统这是一个覆盖实现
+- **Partial 类**：允许将类的定义分散到多个文件中，便于组织代码
+- **函数签名匹配**：C# 函数的参数和返回值类型必须与 C++ 声明保持一致
+- **引用参数**：`ref` 关键字对应 C++ 中的引用参数 `&`
+
+:::
---
-## 代码扫描
-在生成C#工程的时候，会先通过[Microsoft.CodeAnalysis.CSharp](https://www.nuget.org/packages/Microsoft.CodeAnalysis.CSharp/)对项目代码进行一次代码扫描，分析出标记有`Override`的类和函数，并且生成到`项目/Intermediate/CodeAnalysis`中，避免覆盖函数后续再生成，导致重定义。
+## 🔍 代码扫描机制
+
+### 工作原理
+
+在生成 C# 工程时，系统会执行以下自动化流程：
+
+```mermaid
+graph LR
+ A[🔄 项目生成开始] --> B[📊 代码扫描]
+ B --> C[🔍 分析 Override 标记]
+ C --> D[📁 生成分析文件]
+ D --> E[🚫 避免重定义]
+ E --> F[✅ 生成完成]
+```
+
+### 技术细节
+
+1. **扫描工具**：使用 [Microsoft.CodeAnalysis.CSharp](https://www.nuget.org/packages/Microsoft.CodeAnalysis.CSharp/) 进行静态代码分析
+2. **扫描目标**：检测所有标记了 `[Override]` 特性的类和函数
+3. **输出位置**：分析结果保存在 `项目/Intermediate/CodeAnalysis` 目录
+4. **防冲突**：确保覆盖函数不会在后续生成中重复定义，避免编译错误
+
+:::note 📝 技术说明
+
+这一机制确保了覆盖函数的稳定性和一致性，让开发者可以安心使用函数覆盖功能而无需担心代码生成冲突。
+
+:::
+
+---
+
+## 🚀 最佳实践
+
+### ✅ 推荐做法
+
+- **明确命名**：使用描述性的文件名，如 `ClassName.Override.cs`
+- **添加注释**：为覆盖函数添加详细的 XML 文档注释
+- **逻辑清晰**：保持覆盖函数的逻辑简洁明了
+- **错误处理**：适当添加参数验证和异常处理
+
+### ❌ 避免做法
+
+- **重复覆盖**：避免在多个 Partial 类中覆盖同一个函数
+- **签名不匹配**：确保函数签名与原始声明完全一致
+- **过度复杂**：避免在覆盖函数中实现过于复杂的逻辑
---
diff --git a/docs/document/getting-started/reflection.md b/docs/document/getting-started/reflection.md
index 0a2ae5e..48298cd 100644
--- a/docs/document/getting-started/reflection.md
+++ b/docs/document/getting-started/reflection.md
@@ -1,7 +1,7 @@
---
-title: 反射
-description: 介绍对于UE反射的支持，变量访问和函数调用
-hide_title: true
+title: 反射系统 (Reflection System)
+description: 深入了解 UnrealCSharp 对 UE 反射系统的完整支持，包括类型映射、变量访问和函数调用
+hide_title: false
slug: reflection
sidebar_position: 2
custom_edit_url: null
@@ -10,27 +10,97 @@ custom_edit_url: null
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
-## 介绍
+# 🪞 反射系统
-通过UE提供的反射，插件会根据[配置](../guides/configuration/editor)生成指定模块和插件下的类，结构体，枚举，以及资源类型。
+## 🌟 概述
+
+UnrealCSharp 插件基于 **Unreal Engine 反射系统** 构建，能够根据[编辑器配置](../guides/configuration/editor)自动生成指定模块和插件下的各种类型绑定。
+
+### � 支持的类型
+
+| 类型 | 图标 | 描述 |
+|------|------|------|
+| **类 (Classes)** | 🏗️ | UObject、Actor 等 C++ 类 |
+| **结构体 (Structs)** | 📦 | USTRUCT 标记的结构体 |
+| **枚举 (Enums)** | 🔢 | UENUM 标记的枚举类型 |
+| **资源类型 (Assets)** | 🎯 | 各种 UE 资源类型 |
+
+:::tip 💡 核心优势
+🔄 **无缝互操作**：C++ 和 C# 之间的完美桥接
+⚡ **实时同步**：反射类型变更自动同步
+🛡️ **类型安全**：编译时类型检查保障
+🚀 **高性能**：原生 UE 反射系统性能
+:::
---
-## 基础概念
+## 🧭 类型映射规则
+
+UE 和 C# 两侧的反射类型存在 **一一对应关系**。对于复杂类型（如 UObject、蓝图等），需要理解 UE 中 **Package** 的概念。
-UE和C#两侧的反射类型存在一一对应关系，对于简单类型比较容易理解，针对如UObject，蓝图等此类复杂类型，需要先了解一下UE中Package的概念，推荐[UE4的资源管理](https://zhuanlan.zhihu.com/p/357904199)和[[中文直播]第33期 | UE4资产管理基础1 | Epic 大钊](https://www.bilibili.com/video/BV1Mr4y1A7nZ)。
+:::note 📚 学习资源
+📖 [UE4的资源管理 - 知乎专栏](https://zhuanlan.zhihu.com/p/357904199)
+🎥 [UE4资产管理基础 - Epic 官方直播](https://www.bilibili.com/video/BV1Mr4y1A7nZ)
+:::
+
+### 🔄 映射规则详解
-
+
+
+**🔧 转换规则**：去掉首位 `/`，将 `/` 替换为 `.`
-如AActor，会将`/Script/Engine.Actor`映射为`Script.Engine.Actor`，规则为去掉首位`/`，并将`/`替换为`.`
+```cpp title="💡 映射示例"
+// 📍 C++ 类型路径
+/Script/Engine.Actor
+
+// ➡️ 映射后的 C# 命名空间
+Script.Engine.Actor
+```
+
+**📋 常见映射示例**：
+
+| 🎯 C++ 类型 | ➡️ | 🎯 C# 类型 |
+|-------------|-----|------------|
+| `AActor` | → | `Script.Engine.Actor` |
+| `UObject` | → | `Script.CoreUObject.Object` |
+| `FVector` | → | `Script.CoreUObject.Vector` |
-
+
+
+**🎨 转换规则**：添加 `Script/` 前缀，去掉重复的类名部分，将 `/` 替换为 `.`
+
+```cpp title="💡 映射示例"
+// 📍 蓝图类型路径
+/Game/UnitTest/Reflection/BP_TestReflectionPropertyActor.BP_TestReflectionPropertyActor_C
+
+// ➡️ 映射后的 C# 命名空间
+Script.Game.UnitTest.Reflection.BP_TestReflectionPropertyActor_C
+```
+
+**🔄 转换步骤流程**：
+
+```mermaid
+graph LR
+ A["📝 原路径"] --> B["➕ 添加前缀"]
+ B --> C["🗑️ 去掉重复"]
+ C --> D["🔄 替换分隔符"]
+
+ style A fill:#e1f5fe
+ style B fill:#f3e5f5
+ style C fill:#fff3e0
+ style D fill:#e8f5e8
+```
-如BP_TestReflectionPropertyActor_C，会将`/Game/UnitTest/Reflection/BP_TestReflectionPropertyActor.BP_TestReflectionPropertyActor_C`映射为`Script.Game.UnitTest.Reflection.BP_TestReflectionPropertyActor_C`，规则为加上`Script/`，去掉`BP_TestReflectionPropertyActor.`，并将`/`替换为`.`
+| 步骤 | 内容 |
+|------|------|
+| 1️⃣ **原路径** | `/Game/UnitTest/Reflection/BP_TestReflectionPropertyActor.BP_TestReflectionPropertyActor_C` |
+| 2️⃣ **添加前缀** | `Script/Game/UnitTest/Reflection/BP_TestReflectionPropertyActor.BP_TestReflectionPropertyActor_C` |
+| 3️⃣ **去掉重复** | `Script/Game/UnitTest/Reflection/BP_TestReflectionPropertyActor_C` |
+| 4️⃣ **替换分隔符** | `Script.Game.UnitTest.Reflection.BP_TestReflectionPropertyActor_C` |
@@ -38,53 +108,65 @@ UE和C#两侧的反射类型存在一一对应关系，对于简单类型比较
---
-## 数据类型
+## 📊 数据类型
-针对不同的数据类型，有不同的处理方式，分为以下几个大类。
+针对不同的数据类型，插件提供了对应的映射机制，确保类型安全和性能优化。
+
+:::info 🎯 设计理念
+每种数据类型都经过精心设计，在保证功能完整性的同时，最大化性能表现。
+:::
-
-
-| C++ | C# |
-| -------- | -------- |
-| bool | bool |
-| int8 | sbyte |
-| int16 | short |
-| int32 | int |
-| int64 | long |
-| uint8 | byte |
-| uint16 | ushort |
-| uint32 | uint |
-| uint64 | ulong |
-| float | float |
-| double | double |
+
+
+基本类型提供了 C++ 和 C# 之间的直接映射，确保最佳性能。
+
+| 🎯 C++ 类型 | ➡️ | 🎯 C# 类型 | 📝 说明 |
+|-------------|-----|------------|---------|
+| `bool` | → | `bool` | 布尔值 |
+| `int8` | → | `sbyte` | 8位有符号整数 |
+| `int16` | → | `short` | 16位有符号整数 |
+| `int32` | → | `int` | 32位有符号整数 |
+| `int64` | → | `long` | 64位有符号整数 |
+| `uint8` | → | `byte` | 8位无符号整数 |
+| `uint16` | → | `ushort` | 16位无符号整数 |
+| `uint32` | → | `uint` | 32位无符号整数 |
+| `uint64` | → | `ulong` | 64位无符号整数 |
+| `float` | → | `float` | 单精度浮点数 |
+| `double` | → | `double` | 双精度浮点数 |
-
+
+
+UE 提供了多种字符串类型，每种都有其特定的用途和性能特征。
-| C++ | C# |
-| -------- | -------- |
-| FName | Script.CoreUObject.FName |
-| FText | Script.CoreUObject.FText |
-| FString | Script.CoreUObject.FString |
+| 🎯 C++ 类型 | ➡️ | 🎯 C# 类型 | 📝 用途 |
+|-------------|-----|------------|---------|
+| `FName` | → | `Script.CoreUObject.FName` | 🏷️ 标识符，内存优化 |
+| `FText` | → | `Script.CoreUObject.FText` | 🌍 本地化文本显示 |
+| `FString` | → | `Script.CoreUObject.FString` | 📄 通用字符串处理 |
+
+:::tip 💡 选择建议
+- **FName**：用于标识符、资源名称等不变字符串
+- **FText**：用于用户界面显示文本，支持本地化
+- **FString**：用于一般字符串操作和处理
+:::
-
+
-对于枚举和TEnumAsByte都会被对应到映射关系下的枚举。
+枚举类型（包括 `TEnumAsByte`）会自动映射到对应的 C# 枚举，保持类型安全。
-
-示例：枚举
+💡 查看枚举映射示例
+
-
-
-```cpp
+```cpp title="ETestEnum.h"
UENUM(BlueprintType)
enum ETestEnum
{
@@ -96,9 +178,9 @@ enum ETestEnum
-
+
-```csharp
+```csharp title="ETestEnum.cs"
using Script.CoreUObject;
namespace Script.UnrealCSharpTest
@@ -114,26 +196,30 @@ namespace Script.UnrealCSharpTest
```
-
+:::note 📋 特点说明
+✅ **自动生成**：基于 C++ 枚举自动生成
+✅ **类型安全**：编译时类型检查
+✅ **值对应**：枚举值完全一致
+✅ **属性标记**：包含路径名等元数据
+:::
+
-
+
-会生成反射变量，StaticStruct，构造函数和析构函数等。
+结构体会生成完整的 C# 类，包含反射变量、静态结构体信息、构造函数和析构函数等。
-
-示例：结构体
+💡 查看结构体映射示例
+
-
-
-```cpp
+```cpp title="FTestStruct.h"
USTRUCT(BlueprintType)
struct FTestStruct
{
@@ -146,9 +232,9 @@ struct FTestStruct
-
+
-```csharp
+```csharp title="FTestStruct.cs"
using Script.Library;
using Script.CoreUObject;
@@ -177,7 +263,6 @@ namespace Script.UnrealCSharpTest
public int Value
{
get => FPropertyImplementation.FProperty_GetStructInt32PropertyImplementation(GarbageCollectionHandle, __Value);
-
set => FPropertyImplementation.FProperty_SetStructInt32PropertyImplementation(GarbageCollectionHandle, __Value, value);
}
@@ -189,26 +274,30 @@ namespace Script.UnrealCSharpTest
```
-
+:::note 🔧 功能特性
+✅ **完整映射**：包含所有 UPROPERTY 变量
+✅ **内存管理**：自动处理生命周期
+✅ **运算符重载**：支持比较操作
+✅ **反射支持**：提供 StaticStruct 信息
+:::
+
-
+
-会生成反射变量，反射函数，接口函数和StaticClass等。
+UObject 类型会生成包含反射变量、反射函数、接口函数和 StaticClass 等完整功能的 C# 类。
-
-示例：UObject
+💡 查看 UObject 映射示例
+
-
-
-```cpp
+```cpp title="ATestReflectionPropertyActor.h"
#pragma once
#include "CoreMinimal.h"
@@ -233,9 +322,9 @@ public:
-
+
-```csharp
+```csharp title="ATestReflectionPropertyActor.cs"
using Script.Engine;
using Script.CoreUObject;
using Script.Library;
@@ -248,7 +337,6 @@ namespace Script.UnrealCSharpTest
public int Int32Value
{
get => FPropertyImplementation.FProperty_GetObjectInt32PropertyImplementation(GarbageCollectionHandle， __Int32Value);
-
set => FPropertyImplementation.FProperty_SetObjectInt32PropertyImplementation(GarbageCollectionHandle， __Int32Value, value);
}
@@ -263,62 +351,83 @@ namespace Script.UnrealCSharpTest
```
-
+:::note 🎯 核心特性
+✅ **继承关系**：完整保持 C++ 的继承链
+✅ **接口支持**：自动实现所有接口
+✅ **属性访问**：Properties 方式访问变量
+✅ **静态信息**：提供 StaticClass 反射信息
+:::
+
-
+
+
+UE 的模板类型提供了类型安全的泛型支持，在 C# 中映射为对应的泛型类。
+
+| 🎯 C++ 模板类型 | ➡️ | 🎯 C# 泛型类型 | 📝 用途 |
+|-----------------|-----|----------------|---------|
+| `TScriptInterface` | → | `Script.CoreUObject.TScriptInterface` | 🔌 接口引用 |
+| `TSubclassOf` | → | `Script.CoreUObject.TSubclassOf` | 🏷️ 类类型引用 |
+| `TWeakObjectPtr` | → | `Script.CoreUObject.TWeakObjectPtr` | 🔗 弱引用指针 |
+| `TLazyObjectPtr` | → | `Script.CoreUObject.TLazyObjectPtr` | ⏳ 延迟加载指针 |
+| `TSoftObjectPtr` | → | `Script.CoreUObject.TSoftObjectPtr` | 💾 软引用指针 |
+| `TSoftClassPtr` | → | `Script.CoreUObject.TSoftClassPtr` | 🏗️ 软类引用 |
+| `TOptional` | → | `Script.CoreUObject.TOptional` | ❓ 可选值类型 |
-| C++ | C# |
-| -------- | -------- |
-| TScriptInterface | Script.CoreUObject.TScriptInterface`1 |
-| TSubclassOf | Script.CoreUObject.TSubclassOf`1 |
-| TWeakObjectPtr | Script.CoreUObject.TWeakObjectPtr`1 |
-| TLazyObjectPtr | Script.CoreUObject.TLazyObjectPtr`1 |
-| TSoftObjectPtr | Script.CoreUObject.TSoftObjectPtr`1 |
-| TSoftClassPtr | Script.CoreUObject.TSoftClassPtr`1 |
-| TOptional | Script.CoreUObject.TOptional`1 |
+:::tip 💡 使用建议
+- **TWeakObjectPtr**：避免循环引用的安全选择
+- **TSoftObjectPtr**：异步加载资源的最佳实践
+- **TOptional**：表示可能为空的值，增强代码健壮性
+:::
-
+
-| C++ | C# |
-| -------- | -------- |
-| TArray | Script.CoreUObject.TArray`1 |
-| TSet | Script.CoreUObject.TSet`1 |
-| TMap | Script.CoreUObject.TMap`2 |
+UE 的容器类型在 C# 中提供了对应的泛型集合实现。
+
+| 🎯 C++ 容器 | ➡️ | 🎯 C# 泛型容器 | 📝 特性 |
+|-------------|-----|----------------|---------|
+| `TArray` | → | `Script.CoreUObject.TArray` | 📚 动态数组，高效随机访问 |
+| `TSet` | → | `Script.CoreUObject.TSet` | 🎯 唯一元素集合，快速查找 |
+| `TMap` | → | `Script.CoreUObject.TMap` | 🗂️ 键值对映射，高效关联 |
+
+:::note 🚀 性能特点
+- **TArray**：内存连续，缓存友好，适合频繁遍历
+- **TSet**：哈希实现，O(1) 查找，适合去重和成员检测
+- **TMap**：哈希表，快速键值查找，适合数据关联
+:::
-
+
-单播和多播都会映射为C#中的类，并且提供相关操作函数。
+UE 的单播和多播委托在 C# 中映射为对应的委托类，提供完整的事件处理机制。
+
-
+单播委托适用于一对一的事件回调场景。
-
-示例：单播
+💡 查看单播委托示例
+
-
-
-```cpp
+```cpp title="FOnPointerEvent.h"
DECLARE_DYNAMIC_DELEGATE_RetVal_TwoParams(FEventReply, FOnPointerEvent, FGeometry, MyGeometry, const FPointerEvent&, MouseEvent);
```
-
+
-```csharp
+```csharp title="FOnPointerEvent.cs"
using System;
using Script.CoreUObject;
using Script.Library;
@@ -342,32 +451,38 @@ namespace Script.UMG.Widget
```
-
+:::note 🎯 单播委托特点
+✅ **类型安全**：强类型参数和返回值
+✅ **单一绑定**：一个委托只能绑定一个方法
+✅ **高性能**：直接调用，无需遍历
+✅ **返回值支持**：可以获取执行结果
+:::
+
-
+
-
+多播委托适用于一对多的事件广播场景。
-示例：多播
+
+💡 查看多播委托示例
+
-
-
-```cpp
+```cpp title="FOnButtonClickedEvent.h"
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FOnButtonClickedEvent);
```
-
+
-```csharp
+```csharp title="FOnButtonClickedEvent.cs"
using System;
using Script.CoreUObject;
using Script.Library;
@@ -389,13 +504,18 @@ namespace Script.UMG
```
-
+:::note 🎯 多播委托特点
+✅ **多重绑定**：可以绑定多个方法
+✅ **广播机制**：一次调用触发所有绑定
+✅ **事件系统**：适合实现观察者模式
+✅ **动态管理**：运行时添加/移除绑定
+:::
+
-
@@ -404,19 +524,23 @@ namespace Script.UMG
---
-## 变量访问
+## 🔧 变量访问
-对于C++或者蓝图中的反射变量，会生成对应的[Properties](https://learn.microsoft.com/en-us/dotnet/csharp/programming-guide/classes-and-structs/properties)，而非[Fields](https://learn.microsoft.com/en-us/dotnet/csharp/programming-guide/classes-and-structs/fields)，实际内存还是放在C++侧。
+反射变量在 C# 中以 **Properties**（属性）的形式呈现，而非 Fields（字段），这样可以确保数据的实际存储仍在 C++ 端，同时提供类型安全的访问接口。
-
+:::info 🎯 设计理念
+**Properties 设计**：确保数据完整性和性能最优
+**C++ 内存**：实际数据存储在 C++ 侧，避免数据同步问题
+**类型安全**：编译时检查，运行时保障
+:::
-示例：变量访问
+
+💡 查看变量访问示例
+
-
-
-```cpp
+```cpp title="ATestReflectionPropertyActor.h"
#pragma once
#include "CoreMinimal.h"
@@ -440,9 +564,9 @@ public:
-
+
-```csharp
+```csharp title="PropertyAccessExample.cs"
using Script.CoreUObject;
namespace Script.UnrealCSharpTest
@@ -451,37 +575,53 @@ namespace Script.UnrealCSharpTest
{
private void TestReflectionProperty()
{
+ // 🎯 创建Actor实例
var PropertyActor = GetWorld().SpawnActor(new FTransform());
+ // 📖 读取属性值
var Int32Value = PropertyActor.Int32Value;
+ // ✏️ 设置属性值
PropertyActor.Int32Value = 21;
+
+ // 🎉 属性访问完全类型安全！
}
}
}
```
-
+:::note 💡 访问特点
+✅ **智能提示**：VS Code/Visual Studio 完整支持
+✅ **类型检查**：编译时验证类型匹配
+✅ **性能优化**：直接访问 C++ 内存
+✅ **调试友好**：可在调试器中查看值
+:::
+
---
-## 函数调用
+## ⚡ 函数调用
-对于C++或者蓝图中的反射函数，会生成对应的C#函数，并且处理好函数默认参数。
+C++ 和蓝图中的反射函数会自动生成对应的 C# 方法，包括完整的参数处理、默认值支持和返回值处理。
-
+:::tip 🚀 功能亮点
+**自动映射**：无需手动绑定，自动生成调用代码
+**参数支持**：完整支持输入、输出、引用参数
+**默认值**：保持 C++ 函数的默认参数行为
+**异常安全**：提供完整的错误处理机制
+:::
-示例：函数调用
+
+💡 查看函数调用示例
+
-
-
-```cpp
+```cpp title="ATestReflectionFunctionActor.h"
#pragma once
#include "CoreMinimal.h"
@@ -511,9 +651,9 @@ public:
-
+
-```csharp
+```csharp title="FunctionCallExample.cs"
using Script.CoreUObject;
using Script.Engine;
@@ -523,24 +663,52 @@ namespace Script.UnrealCSharpTest
{
private void TestReflectionFunction()
{
+ // 🎯 创建函数测试Actor
var FunctionActor = GetWorld().SpawnActor(new FTransform());
+ // 📖 调用获取函数（返回值）
var Int32Value = FunctionActor.GetInt32ValueFunction();
+ // ✏️ 调用设置函数（输入参数）
FunctionActor.SetInt32ValueFunction(21);
+ // 🔄 调用输出函数（引用参数）
var OutInt32Value = 12;
-
FunctionActor.OutInt32ValueFunction(ref OutInt32Value);
+ // OutInt32Value 现在包含函数输出的值
}
}
}
```
-
+:::note 🎯 调用特点
+✅ **完整映射**：支持所有 UFUNCTION 函数
+✅ **参数类型**：输入、输出、引用参数完整支持
+✅ **返回值**：正确处理各种返回类型
+✅ **异步支持**：对于异步函数提供 async/await 支持
+:::
+
---
+
+## 🎉 总结
+
+UnrealCSharp 的反射系统为 C++ 和 C# 之间搭建了一座无缝的桥梁：
+
+| 🎯 核心特性 | 📝 说明 | 🚀 优势 |
+|-------------|---------|---------|
+| **自动生成** | 基于 UE 反射自动生成绑定 | 无需手动维护绑定代码 |
+| **类型安全** | 编译时类型检查 | 减少运行时错误 |
+| **高性能** | 直接访问 C++ 内存 | 接近原生性能 |
+| **完整支持** | 涵盖所有 UE 反射类型 | 功能无缺失 |
+
+:::tip 🎯 最佳实践
+1. **充分利用**：使用 IntelliSense 提高开发效率
+2. **类型检查**：依赖编译器捕获类型错误
+3. **性能考虑**：大量数据处理时注意内存布局
+4. **调试技巧**：使用混合模式调试追踪 C++/C# 调用栈
+:::
diff --git a/docs/document/guides/command.md b/docs/document/guides/command.md
index e5c1a99..47c656f 100644
--- a/docs/document/guides/command.md
+++ b/docs/document/guides/command.md
@@ -1,17 +1,220 @@
---
-title: 命令
-description: 控制台命令
-hide_title: true
-slug: command
+title: ⌨️ 控制台命令
+description: UnrealCSharp 控制台命令完整指南
+hide_title: false
sidebar_position: 2
custom_edit_url: null
---
-## Editor
+# ⌨️ 控制台命令
-- `UnrealCSharp.Editor.CodeAnalysis`，代码分析
-- `UnrealCSharp.Editor.SolutionGenerator`，生成解决方案
-- `UnrealCSharp.Editor.Compile`，编译代码
-- `UnrealCSharp.Editor.Generator`，完整生成
+
+
+ 🚀 使用控制台命令高效管理您的 C# 项目
+
+
+
+
+
+
🔍 代码分析
+
+
+
命令：UnrealCSharp.Editor.CodeAnalysis
+
功能：分析 C# 代码质量和潜在问题
+
用途：
+
+ - 检查代码规范
+ - 发现潜在错误
+ - 优化建议
+
+
+
+
+
+
+
+
📝 生成解决方案
+
+
+
命令：UnrealCSharp.Editor.SolutionGenerator
+
功能：生成 Visual Studio 解决方案文件
+
用途：
+
+ - 创建 .sln 文件
+ - 配置项目引用
+ - IDE 集成支持
+
+
+
+
+
+
+
+
+
🔨 编译代码
+
+
+
命令：UnrealCSharp.Editor.Compile
+
功能：编译 C# 代码并热重载
+
用途：
+
+ - 增量编译
+ - 热重载更新
+ - 快速验证修改
+
+
+
+
+
+
+
+
⚡ 完整生成
+
+
+
命令：UnrealCSharp.Editor.Generator
+
功能：完整重新生成 C# 项目
+
用途：
+
+ - 全量代码生成
+ - 解决方案重建
+ - 清理并重新开始
+
+
+
+
+
+ 💡 三种执行方式：
+
+
+1. **编辑器控制台**
+ - 按下 `` ` `` 键打开控制台
+ - 输入命令并按回车
+
+2. **输出日志窗口**
+ - Window → Developer Tools → Output Log
+ - 在命令输入框中执行
+
+3. **蓝图节点**
+ - 在蓝图中使用 "Execute Console Command" 节点
+ - 适合自动化流程
+
+### ⚡ 常用命令组合
+
+
+
+
+
+
🔄 开发工作流
+
+
+
+ UnrealCSharp.Editor.CodeAnalysisUnrealCSharp.Editor.Compile- 测试功能
+ - 重复步骤 1-3
+
+
+
+
+
+
+
+
🚀 项目初始化
+
+
+
+ UnrealCSharp.Editor.GeneratorUnrealCSharp.Editor.SolutionGenerator- 在 IDE 中打开解决方案
+ - 开始开发
+
+
+
+
+
+ 💡 持续集成建议：
+
+
+- 在 CI 流程中使用 `UnrealCSharp.Editor.CodeAnalysis` 进行质量检查
+- 使用 `UnrealCSharp.Editor.Compile` 验证代码可编译性
+- 定期使用 `UnrealCSharp.Editor.Generator` 确保代码生成一致性
+
+---
+
+## ⚠️ 注意事项
+
+### 🚨 执行顺序
+
+
+ ⚠️ 重要提醒：
+
+
+- 首次使用时必须先执行 `UnrealCSharp.Editor.Generator`
+- 代码分析应在编译前进行
+- 修改绑定后需要重新生成解决方案
+
+### 🐛 故障排除
+
+| 问题 | 解决方案 |
+|------|----------|
+| 命令无法识别 | 确认插件已正确加载 |
+| 编译失败 | 检查 C# 代码语法错误 |
+| 生成失败 | 验证项目结构完整性 |
+
+---
+
+## 🤝 更多帮助
+
+
---
diff --git a/docs/document/guides/configuration/editor.md b/docs/document/guides/configuration/editor.md
index b2d4fca..19e865e 100644
--- a/docs/document/guides/configuration/editor.md
+++ b/docs/document/guides/configuration/editor.md
@@ -1,57 +1,113 @@
---
title: Editor
-description: Editor配置参数
+description: Editor配置参数详解
hide_title: true
slug: editor
sidebar_position: 1
custom_edit_url: null
---
-### DotNet
+# Editor 配置参数
-- DotNetPath，DotNet路径
- - Windows上默认为`C:/Program Files/dotnet/dotnet.exe`
- - macOS上默认为`/usr/local/share/dotnet/dotnet`
+本文档详细介绍UnrealCSharp在编辑器模式下的各项配置参数，帮助开发者根据项目需求进行个性化配置。
+
+## DotNet 配置
+
+配置.NET运行时环境相关参数。
+
+| 参数名 | 类型 | 默认值 | 描述 |
+|--------|------|--------|------|
+| `DotNetPath` | string | 见下方说明 | .NET可执行文件的完整路径 |
+
+**默认路径：**
+- **Windows**: `C:/Program Files/dotnet/dotnet.exe`
+- **macOS**: `/usr/local/share/dotnet/dotnet`
+
+:::tip 提示
+确保指定的.NET路径存在且可执行，建议使用.NET 6.0及以上版本。
+:::
---
-### Generator
-
-- ScriptDirectory，脚本目录，默认为Script
-- bEnableDeleteProxyDirectory，是否删除Proxy目录，默认关闭
-- bEnableCompiled，是否开启编译，默认开启
-- bEnableAssetChanged，是否开启监听资源变更，默认开启
-- bEnableDirectoryChanged，是否开启监听C#文件变更，默认开启
-- bIsSkipGenerateEngineModules，是否跳过引擎侧生成，默认关闭，当确认引擎侧不需要重复生成时，可开启，用于加快生成速度
-- bIsGenerateAllModules，是否全量生成，默认开启，当想要通过SupportedModule自定义生成规则时，可关闭
-- SupportedModule，需要对C++代码生成C#代码的模块或者插件
- - 对于类，需要类继承的基类以及接口被导出
- - 对于变量，需要变量类型被导出
- - 对于函数，需要函数所有参数类型以及返回值类型被导出
- - 默认添加如下模块或者插件：
- - Core
- - CoreUObject
- - Engine
- - SlateCore
- - FieldNotification
- - UMG
- - UnrealCSharpCore
- - `项目`
-- bIsGenerateAsset，是否生成资源类型，默认开启，当确认不需要生成资源类型时，可关闭，用于加快生成速度
-- SupportedAssetPath，需要对资源生成C#代码的模块或者插件
- - 默认添加`项目`
-- SupportedAssetClass，需要对资源生成C#代码的资源类型
- - 对于蓝图类，会生成变量和函数
- - 对于蓝图结构体，会生成变量
- - 对于蓝图枚举，会生成枚举值
- - 对于其他类型，会生成继承资源类型的空类，主要用于防止资源路径硬编码，可借助代码分析工具实现收集C#侧资源引用情况
- - 默认添加如下资源类型：
- - Blueprint
- - UserDefinedStruct
- - UserDefinedEnum
- - WidgetBlueprint
-- bIsGenerateFunctionComment，是否生成函数注释，默认开启
-- bEnableExport，是否开启通过UHT生成静态绑定代码，默认关闭
-- ExportModule，需要通过UHT生成静态绑定代码的模块或者插件
+## Generator 生成器配置
+
+控制C#代码生成和编译相关的配置参数。
+
+### 基础配置
+
+| 参数名 | 类型 | 默认值 | 描述 |
+|--------|------|--------|------|
+| `ScriptDirectory` | string | `Script` | C#脚本存放的根目录名称 |
+| `bEnableDeleteProxyDirectory` | bool | `false` | 是否在生成前删除Proxy目录 |
+| `bEnableCompiled` | bool | `true` | 是否启用自动编译功能 |
+
+### 监听配置
+
+| 参数名 | 类型 | 默认值 | 描述 |
+|--------|------|--------|------|
+| `bEnableAssetChanged` | bool | `true` | 是否监听UE资源文件变更并自动重新生成 |
+| `bEnableDirectoryChanged` | bool | `true` | 是否监听C#文件变更并自动重新编译 |
+
+### 模块生成配置
+
+| 参数名 | 类型 | 默认值 | 描述 |
+|--------|------|--------|------|
+| `bIsSkipGenerateEngineModules` | bool | `false` | 跳过引擎模块的重复生成以提升速度 |
+| `bIsGenerateAllModules` | bool | `true` | 是否生成所有模块，关闭时使用SupportedModule自定义 |
+
+#### SupportedModule（支持的模块）
+
+指定需要从C++代码生成C#绑定的模块或插件列表。
+
+**生成要求：**
+- **类**: 基类和接口必须被导出
+- **变量**: 变量类型必须被导出
+- **函数**: 所有参数类型和返回值类型必须被导出
+
+**默认包含的模块：**
+- `Core` - UE核心模块
+- `CoreUObject` - UE对象系统
+- `Engine` - UE引擎模块
+- `SlateCore` - UI核心模块
+- `FieldNotification` - 字段通知系统
+- `UMG` - UE用户界面系统
+- `UnrealCSharpCore` - UnrealCSharp核心模块
+- 当前项目模块
+
+### 资源生成配置
+
+| 参数名 | 类型 | 默认值 | 描述 |
+|--------|------|--------|------|
+| `bIsGenerateAsset` | bool | `true` | 是否生成资源类型的C#绑定 |
+
+#### SupportedAssetPath（支持的资源路径）
+
+指定需要生成C#代码的资源所在的模块或插件路径。
+
+**默认值：** 当前项目
+
+#### SupportedAssetClass（支持的资源类型）
+
+指定需要生成C#绑定的资源类型及其生成规则：
+
+| 资源类型 | 生成内容 | 说明 |
+|----------|----------|------|
+| `Blueprint` | 变量和函数 | 蓝图类的完整绑定 |
+| `UserDefinedStruct` | 变量 | 用户定义结构体 |
+| `UserDefinedEnum` | 枚举值 | 用户定义枚举 |
+| `WidgetBlueprint` | 变量和函数 | UI蓝图的完整绑定 |
+| 其他类型 | 空类继承 | 防止资源路径硬编码，便于引用分析 |
+
+### 其他配置
+
+| 参数名 | 类型 | 默认值 | 描述 |
+|--------|------|--------|------|
+| `bIsGenerateFunctionComment` | bool | `true` | 是否在生成的C#代码中包含函数注释 |
+| `bEnableExport` | bool | `false` | 是否通过UHT生成静态绑定代码 |
+| `ExportModule` | array | `[]` | 需要通过UHT生成静态绑定的模块列表 |
+
+:::warning 注意
+`bEnableExport` 功能仍在实验阶段，建议在生产环境中谨慎使用。
+:::
---
\ No newline at end of file
diff --git a/docs/document/guides/configuration/runtime.md b/docs/document/guides/configuration/runtime.md
index 9d6e1c2..b05564f 100644
--- a/docs/document/guides/configuration/runtime.md
+++ b/docs/document/guides/configuration/runtime.md
@@ -1,49 +1,135 @@
---
title: Runtime
-description: Runtime配置参数
+description: Runtime运行时配置参数详解
hide_title: true
slug: runtime
sidebar_position: 2
custom_edit_url: null
---
-### Publish
+# Runtime 运行时配置
-- PublishDirectory，发布目录，默认为Script
-- UEName，UE程序集名
-- GameName，Game程序集名
-- CustomProjects，自定义程序集
+本文档详细介绍UnrealCSharp在运行时的各项配置参数，涵盖程序集发布、函数覆盖、域管理、绑定和调试等关键功能。
+
+## Publish 发布配置
+
+配置程序集的发布和加载相关参数。
+
+| 参数名 | 类型 | 默认值 | 描述 |
+|--------|------|--------|------|
+| `PublishDirectory` | string | `Script` | 已编译程序集的发布目录 |
+| `UEName` | string | - | UE引擎程序集的名称 |
+| `GameName` | string | - | 游戏项目程序集的名称 |
+| `CustomProjects` | array | `[]` | 自定义程序集列表，用于加载额外的程序集 |
+
+:::info 说明
+`PublishDirectory` 指定运行时加载程序集的目录，通常与编译输出目录保持一致。
+:::
---
-### Override
+## Override 函数覆盖配置
+
+控制C#中覆盖UE函数的行为和命名规则。
+
+| 参数名 | 类型 | 默认值 | 描述 |
+|--------|------|--------|------|
+| `bEnableCallOverrideFunction` | bool | `true` | 是否启用调用被覆盖的原始函数功能 |
+| `OverrideFunctionNamePrefix` | string | `""` | 被覆盖函数的名称前缀 |
+| `OverrideFunctionNameSuffix` | string | `_Override` | 被覆盖函数的名称后缀 |
+
+### 使用示例
+
+当覆盖UE中的`BeginPlay`函数时：
+- 原始函数调用：`BeginPlay_Override()` （使用默认后缀）
+- 如果设置前缀为`Super_`：`Super_BeginPlay()`
+
+:::tip 最佳实践
+建议保持默认的`_Override`后缀，这样可以清晰地区分原始函数调用。
+:::
+
+---
+
+## Domain 程序域配置
+
+管理.NET程序集的加载和隔离。
-- bEnableCallOverrideFunction，是否开启调用被覆盖函数，默认开启
-- OverrideFunctionNamePrefix，被覆盖函数前缀，默认为空
-- OverrideFunctionNameSuffix，被覆盖函数后缀，默认为_Override
+| 参数名 | 类型 | 默认值 | 描述 |
+|--------|------|--------|------|
+| `AssemblyLoader` | string | - | 自定义程序集加载器的完整类名 |
+
+### 自定义加载器
+
+可以通过实现自定义加载器来控制程序集的加载行为，例如：
+- 热重载支持
+- 版本管理
+- 依赖解析
---
-### Domain
+## Bind 预绑定配置
+
+配置需要预先绑定的类型，优化运行时性能。
+
+| 参数名 | 类型 | 默认值 | 描述 |
+|--------|------|--------|------|
+| `BindClass` | array | `[]` | 需要预先绑定的C#类型列表 |
+
+### 使用场景
+
+主要用于绑定以下类型：
+- **CDO (Class Default Object)**: 类默认对象
+- **蓝图函数库**: 如`UBlueprintFunctionLibrary`的子类
+- **静态类**: 频繁使用的工具类
+
+### 配置示例
-- AssemblyLoader，自定义程序集加载规则
+```json
+"BindClass": [
+ "MyProject.MyBlueprintFunctionLibrary",
+ "MyProject.Utilities.MathHelper"
+]
+```
---
-### Bind
+## Debug 调试配置
-- BindClass，需要预先绑定的类型，可用于绑定CDO，比如UBlueprintFunctionLibrary
+配置C#代码的调试功能，支持远程调试。
+
+| 参数名 | 类型 | 默认值 | 描述 |
+|--------|------|--------|------|
+| `bEnableDebug` | bool | `false` | 是否启用调试模式 |
+| `Host` | string | `localhost` | 调试服务器地址 |
+| `Port` | int | `4711` | 调试服务器端口 |
+
+### 调试设置
+
+1. **启用调试**: 将`bEnableDebug`设置为`true`
+2. **配置IDE**: 在Visual Studio或VS Code中配置远程调试
+3. **连接调试器**: 使用指定的Host和Port连接
+
+:::warning 性能提醒
+调试模式会影响运行时性能，请在发布版本中关闭此功能。
+:::
---
-### Debug
+## Module 模块配置
+
+控制模块的激活和生命周期管理。
+
+| 参数名 | 类型 | 默认值 | 描述 |
+|--------|------|--------|------|
+| `bEnableImmediatelyActive` | bool | `true` | 是否在加载后立即激活模块 |
-- bEnableDebug，是否开启调试模式
-- Host，调试地址
-- Port，调试端口
+### 模块激活策略
-### Module
+- **立即激活** (`true`): 模块加载后立即执行初始化代码
+- **延迟激活** (`false`): 模块加载后等待手动激活或特定事件触发
-- bEnableImmediatelyActive，是否开启直接启动Module，默认开启
+:::note 注意事项
+对于依赖其他系统的模块，可能需要关闭立即激活以确保正确的初始化顺序。
+:::
---
\ No newline at end of file
diff --git a/docs/document/guides/debug.md b/docs/document/guides/debug.md
index f10f10f..7d04cf1 100644
--- a/docs/document/guides/debug.md
+++ b/docs/document/guides/debug.md
@@ -1,6 +1,6 @@
---
title: 调试
-description: 如何配置和使用调试工具进行调试
+description: UnrealCSharp调试完整指南：从基础配置到真机调试
hide_title: true
slug: debug
sidebar_position: 3
@@ -10,37 +10,163 @@ custom_edit_url: null
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
-## 基础概念
+# C# 调试指南
-[Mono](https://github.com/dotnet/runtime)已经摒弃[Guide:Debugger](https://www.mono-project.com/archived/guidedebugger/)这套调试流程，目前需要参考[C# Compiler Options that control code generation](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-options/code-generation)将`DebugType`设置为`embedded`（插件已处理好）。
+本文档提供UnrealCSharp的完整调试解决方案，包括项目配置、IDE设置和真机调试等内容。
+
+## 📖 基础概念
+
+### 调试机制说明
+
+由于[Mono](https://github.com/dotnet/runtime)已经废弃了传统的[Guide:Debugger](https://www.mono-project.com/archived/guidedebugger/)调试流程，UnrealCSharp采用了新的调试机制：
+
+- **调试符号格式**: 使用`embedded` DebugType（插件已自动配置）
+- **协议支持**: 基于.NET标准调试协议
+- **跨平台兼容**: 支持Windows、macOS、Linux等平台
+
+:::info 技术背景
+根据[C# Compiler Options](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-options/code-generation)文档，`embedded` DebugType将调试信息直接嵌入到程序集中，提供更好的调试体验。
+:::
---
-## 项目配置
+## ⚙️ 项目配置
+
+### Runtime 调试配置
+
+在项目的Runtime配置中启用调试功能：
-参考[配置](../guides/configuration/runtime)
+```json
+{
+ "Debug": {
+ "bEnableDebug": true,
+ "Host": "localhost",
+ "Port": 4711
+ }
+}
+```
+
+| 参数 | 说明 | 默认值 |
+|------|------|--------|
+| `bEnableDebug` | 启用调试模式 | `false` |
+| `Host` | 调试服务器地址 | `localhost` |
+| `Port` | 调试端口 | `4711` |
+
+:::tip 配置建议
+- 开发阶段建议启用调试模式
+- 发布版本务必关闭调试以提升性能
+- 团队开发时可使用不同端口避免冲突
+:::
+
+详细配置参数请参考：[Runtime配置文档](../guides/configuration/runtime#debug-调试配置)
---
-## IDE配置
+## 🛠️ IDE 配置
+
+根据您使用的开发环境选择相应的配置方法：
-
+
+
+### 配置步骤
+
+1. **创建调试配置**
+ - `Run` → `Edit Configurations...`
+ - 点击 `+` → `.NET` → `Mono Remote`
-`Run-Edit Configurations...-Add New Configuration-.NET-Mono Remote`
+2. **配置参数**
+ ```
+ Name: UnrealCSharp Debug
+ Host: localhost
+ Port: 4711
+ ```
+
+3. **高级设置**
+ - ✅ `Suspend on connection`
+ - ✅ `Wait for connections`
+
+### 使用方法
+
+1. 启动UE编辑器或游戏
+2. 在Rider中点击调试按钮
+3. 设置断点并开始调试
+
+:::tip Rider优势
+- 原生支持Mono调试
+- 强大的代码分析功能
+- 优秀的UE集成支持
+:::
-[VSMonoDebugger](https://github.com/GordianDotNet/VSMonoDebugger)
+### 插件安装
+
+安装 [VSMonoDebugger](https://github.com/GordianDotNet/VSMonoDebugger) 扩展：
+
+1. 打开 `Extensions` → `Manage Extensions`
+2. 搜索 "Mono Debugger"
+3. 安装并重启VS
+
+### 配置调试
+
+1. **创建调试配置**
+ - `Debug` → `Attach to Process...`
+ - 选择 `Mono Remote (MonoDebugger)`
+
+2. **连接设置**
+ ```
+ Host: localhost
+ Port: 4711
+ ```
+
+### 注意事项
+
+- 确保VS版本支持该插件
+- 可能需要手动配置符号路径
+- 建议使用VS 2019或更高版本
-[vscode-mono-debug](https://github.com/microsoft/vscode-mono-debug)
+### 插件安装
+
+安装 [vscode-mono-debug](https://github.com/microsoft/vscode-mono-debug) 扩展：
+
+```bash
+code --install-extension ms-vscode.mono-debug
+```
+
+### launch.json 配置
+
+在项目根目录创建 `.vscode/launch.json`：
+
+```json
+{
+ "version": "0.2.0",
+ "configurations": [
+ {
+ "name": "UnrealCSharp Debug",
+ "type": "mono",
+ "request": "attach",
+ "address": "localhost",
+ "port": 4711,
+ "localRoot": "${workspaceFolder}",
+ "remoteRoot": "/path/to/remote/source"
+ }
+ ]
+}
+```
+
+### 调试步骤
+
+1. 按 `F5` 或点击调试按钮
+2. 选择 "UnrealCSharp Debug" 配置
+3. 连接到运行中的UE实例
@@ -48,8 +174,80 @@ import TabItem from '@theme/TabItem';
---
-## 真机调试
+## 📱 真机调试
+
+### 移动端调试配置
+
+对于Android和iOS等移动平台的调试，需要使用反向代理技术：
+
+#### 网络配置
+
+1. **端口转发设置**
+ ```bash
+ # Android (ADB)
+ adb forward tcp:4711 tcp:4711
+
+ # iOS (可使用 libimobiledevice)
+ iproxy 4711 4711
+ ```
+
+2. **防火墙配置**
+ - 确保调试端口在防火墙中开放
+ - 移动设备能够访问开发机器
+
+#### 配置示例
+
+```json
+{
+ "Debug": {
+ "bEnableDebug": true,
+ "Host": "0.0.0.0", // 监听所有网卡
+ "Port": 4711
+ }
+}
+```
+
+### 网络调试
+
+参考 [LuaPanda 真机调试指南](https://github.com/Tencent/LuaPanda/blob/master/Docs/Manual/debug-on-phone.md) 中的反向代理配置方法。
+
+#### 关键步骤
+
+1. **建立代理连接**
+ - 使用USB连接或WiFi网络
+ - 配置端口转发规则
+
+2. **调试器连接**
+ - IDE连接到本地转发端口
+ - 自动转发到设备上的调试端口
+
+3. **断点调试**
+ - 设置断点并启动应用
+ - 在移动设备上触发相应代码
+
+:::warning 注意事项
+- 真机调试可能影响游戏性能
+- 确保网络连接稳定
+- 建议在开发版本中使用
+:::
+
+---
+
+## 🔧 故障排除
+
+### 常见问题
+
+| 问题 | 原因 | 解决方案 |
+|------|------|----------|
+| 连接超时 | 端口被占用或防火墙阻止 | 检查端口状态，配置防火墙规则 |
+| 断点无效 | 调试符号缺失 | 确认DebugType为embedded |
+| 性能下降 | 调试模式开销 | 发布时关闭调试功能 |
+
+### 调试技巧
-参考[debug-on-phone](https://github.com/Tencent/LuaPanda/blob/master/Docs/Manual/debug-on-phone.md)中提及的`反向代理`
+1. **日志输出**: 使用`UE_LOG`输出调试信息
+2. **条件断点**: 在特定条件下触发断点
+3. **监视变量**: 实时查看变量值变化
+4. **调用堆栈**: 分析函数调用路径
---
diff --git a/docs/document/guides/hotreload.md b/docs/document/guides/hotreload.md
index b908263..846c731 100644
--- a/docs/document/guides/hotreload.md
+++ b/docs/document/guides/hotreload.md
@@ -1,20 +1,189 @@
---
title: 编辑器热重载
-description: 编辑器下监听C#文件和资源变更并热重载
+description: UnrealCSharp编辑器热重载机制详解
hide_title: true
slug: hotreload
sidebar_position: 4
custom_edit_url: null
---
-## C#文件变更
+# 编辑器热重载
-使用`IDirectoryWatcher::FDirectoryChanged`监听`Script`项目中`Game`工程的C#文件变更情况，当编辑器切换到前台时，如果检测到有文件变更，则会触发C#编译，当变更列表中存在动态类时，也会对动态类进行热重载。
+UnrealCSharp提供强大的热重载功能，支持C#代码和UE资源的实时更新，大幅提升开发效率。
+
+## 🔄 C#文件热重载
+
+### 工作机制
+
+UnrealCSharp使用`IDirectoryWatcher::FDirectoryChanged`监听Script项目中Game工程的C#文件变更，实现以下流程：
+
+```mermaid
+graph LR
+ A[C#文件修改] --> B[文件监听器检测]
+ B --> C[编辑器切换到前台]
+ C --> D[触发编译]
+ D --> E{存在动态类?}
+ E -->|是| F[执行热重载]
+ E -->|否| G[仅编译]
+ F --> H[更新完成]
+ G --> H
+```
+
+### 触发条件
+
+| 条件 | 说明 |
+|------|------|
+| **文件变更** | C#源文件被修改、添加或删除 |
+| **编辑器激活** | UE编辑器窗口获得焦点时检查变更 |
+| **动态类检测** | 变更列表中包含可热重载的动态类 |
+
+### 监听范围
+
+- **监听目录**: `Script/Game/` 项目目录
+- **文件类型**: `.cs` C#源代码文件
+- **排除项**: 临时文件、备份文件等
+
+### 配置参数
+
+在Editor配置中控制热重载行为：
+
+```json
+{
+ "Generator": {
+ "bEnableDirectoryChanged": true, // 启用C#文件监听
+ "bEnableCompiled": true // 启用自动编译
+ }
+}
+```
+
+:::tip 性能优化
+- 大型项目建议使用增量编译
+- 可通过配置排除不需要监听的目录
+- 建议在SSD上存放项目文件以提升编译速度
+:::
---
-## 资源变更
+## 🎨 资源热重载
+
+### 支持的资源操作
+
+UnrealCSharp监听以下UE资源变更操作：
+
+| 操作类型 | 描述 | 触发行为 |
+|----------|------|----------|
+| **新增** | 创建新的蓝图、结构体等资源 | 生成对应C#绑定文件 |
+| **删除** | 删除现有资源 | 移除对应C#文件 |
+| **修改** | 更新资源内容（如添加变量） | 重新生成C#绑定 |
+| **重命名** | 资源重命名或移动 | 更新C#文件名和命名空间 |
+
+### 资源类型支持
+
+根据[Editor配置](../guides/configuration/editor#supportedassetclass支持的资源类型)，默认支持：
+
+#### 完整绑定（变量+函数）
+- **Blueprint** - 蓝图类
+- **WidgetBlueprint** - UI蓝图
+
+#### 变量绑定
+- **UserDefinedStruct** - 用户定义结构体
+
+#### 枚举绑定
+- **UserDefinedEnum** - 用户定义枚举
+
+#### 类型引用
+- **其他资源类型** - 生成空类以防止硬编码
+
+### 配置示例
+
+```json
+{
+ "Generator": {
+ "bEnableAssetChanged": true,
+ "bIsGenerateAsset": true,
+ "SupportedAssetPath": ["MyProject"],
+ "SupportedAssetClass": [
+ "Blueprint",
+ "UserDefinedStruct",
+ "UserDefinedEnum",
+ "WidgetBlueprint"
+ ]
+ }
+}
+```
+
+### 生成规则
+
+当资源变更时，系统会：
+
+1. **检查资源类型**: 是否在`SupportedAssetClass`列表中
+2. **验证路径**: 资源是否属于`SupportedAssetPath`指定的模块
+3. **生成C#代码**: 创建或覆盖对应的C#绑定文件
+4. **触发编译**: 自动编译更新后的代码
+
+:::info 命名规则
+- C#类名与UE资源名保持一致
+- 命名空间根据资源路径自动生成
+- 特殊字符会被自动转换为有效的C#标识符
+:::
+
+---
+
+## ⚡ 性能优化
+
+### 编译优化
+
+| 策略 | 说明 | 效果 |
+|------|------|------|
+| **增量编译** | 仅编译变更的文件 | 显著减少编译时间 |
+| **并行编译** | 多线程编译支持 | 充分利用多核CPU |
+| **缓存机制** | 缓存编译结果 | 避免重复编译 |
+
+### 监听优化
+
+```json
+{
+ "Generator": {
+ "bIsSkipGenerateEngineModules": true, // 跳过引擎模块重复生成
+ "bIsGenerateAllModules": false, // 使用自定义模块列表
+ "SupportedModule": ["MyProject"] // 仅监听项目模块
+ }
+}
+```
+
+### 文件系统优化
+
+- **SSD存储**: 将项目存放在SSD上
+- **排除监听**: 排除临时文件和缓存目录
+- **合理分组**: 按功能模块组织代码结构
+
+---
+
+## 🚨 注意事项
+
+### 限制条件
+
+- **静态类限制**: 某些静态绑定类型无法热重载
+- **内存引用**: 已创建的对象实例不会自动更新
+- **依赖关系**: 类型依赖变更可能需要重启编辑器
+
+### 最佳实践
+
+1. **及时保存**: 修改后及时保存文件以触发热重载
+2. **避免循环依赖**: 设计时避免复杂的类型依赖关系
+3. **测试验证**: 热重载后及时测试功能是否正常
+4. **备份重要代码**: 重要修改前建议备份代码
+
+### 故障排除
+
+| 问题 | 可能原因 | 解决方案 |
+|------|----------|----------|
+| 热重载失败 | 编译错误 | 检查编译输出，修复语法错误 |
+| 变更未生效 | 缓存问题 | 重启编辑器或清理缓存 |
+| 性能下降 | 频繁重载 | 优化代码结构，减少不必要的变更 |
-当发生资源变更（增加，删除，修改和重命名）时，如果该资源类型以及该资源所属模块或插件在[配置](../guides/configuration/editor)中匹配成功，则会新建或者覆盖对应C#文件，并且触发C#编译。
+:::warning 重要提醒
+热重载功能主要用于开发阶段，打包发布时会使用完整编译流程以确保稳定性。
+:::
---
diff --git a/docs/document/introduction/introduction.md b/docs/document/introduction/introduction.md
index 2bd7b4d..3291c3f 100644
--- a/docs/document/introduction/introduction.md
+++ b/docs/document/introduction/introduction.md
@@ -1,11 +1,150 @@
---
-description: ""
-hide_title: true
+title: UnrealCSharp 介绍
+description: 一个强大的 Unreal Engine C# 编程插件，基于 .NET 8，支持全平台开发
+hide_title: false
custom_edit_url: null
---
-##
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
- UnrealCSharp是UE下C#编程插件，基于.NET 8（Mono），支持全部的反射类型，自动生成C#代码，能够静态导出各种数据类型和函数，同时拥有强大的动态类特性，可以通过C#直接生成UClass，UInterface，UStruct和UEnum，并且不需要蓝图载体。目前已适配Windows，macOS，Linux，Android和IOS多个平台；支持Dedicated Server；支持Editor，Runtime和Android真机调试；能够通过Pak进行热更新；编辑器下，能够热重载C#改动，包括替换动态类。拥有完善的生态，完备的单元测试和回归测试，详细的性能测试，已经使用插件复刻了Epic提供的StackOBot和Cropout游戏示例，目前社区中已经有项目实际接入使用。
+# 🎮 UnrealCSharp
+
+
+
+ 🚀 现代化的 Unreal Engine C# 编程解决方案
+
+
+
+
+
+
🔄 完整反射支持
+
+
+
支持全部反射类型，自动生成 C# 代码，静态导出各种数据类型和函数
+
+
+
+
+
+
+
⚡ 动态类特性
+
+
+
通过 C# 直接生成 UClass、UInterface、UStruct 和 UEnum，无需蓝图载体
+
+
+
+
+
+
+
+
🐛 调试支持
+
+ - Editor 调试
+ - Runtime 调试
+ - Android 真机调试
+
+
+
+
+
+
+
+
🔥 热重载
+
+ - C# 代码热重载
+ - 动态类替换
+ - 编辑器内实时更新
+
+
+
+
+
+
+
+
📦 热更新
+
+ - 通过 Pak 文件热更新
+ - 运行时代码更新
+ - 无需重启应用
+
+
+
+
+
+
+ 🚀 新年新气象，带来更多强大功能！
+
+
+
+
✨ 新增功能
+
+
+
🔧 Module 开关功能
+
新增了灵活的 Module 开关控制，允许开发者按需启用/禁用特定模块。
+
🔗 相关提交： 127c283
+
+
+
💡 优势：
+
+ - 更细粒度的模块控制
+ - 减少不必要的资源占用
+ - 提升项目启动速度
+
+
+
+
+
+
⚡ 性能优化
+
+
+
🔗 引用关系优化
+
重构并优化了模块间的引用关系，提升了系统整体性能。
+
🔗 相关提交： f128e2f
+
+
+
🚀 改进效果：
+
+ - 减少循环依赖
+ - 优化内存使用
+ - 提升编译速度
+
+
+
+
+
+
🆕 功能增强
+
+
+
📦 动态类自定义命名空间
+
动态类现在支持自定义 Namespace，提供更好的代码组织和管理能力。
+
🔗 相关提交： 37106f3
+
+
+
📋 使用场景：
+
+ - 更清晰的代码结构
+ - 避免命名冲突
+ - 便于模块化开发
+
+
+
+
💻 示例代码：
+ ```csharp
+ [UClass(Namespace = "MyGame.Gameplay")]
+ public class MyGameplayActor : AActor
+ {
+ // 现在位于 MyGame.Gameplay 命名空间下
+ }
+ ```
+
+
+
+
🔧 问题修复
+
+
+
⚙️ IsNativeFunction 修复
+
修复了 IsNativeFunction 判断逻辑的错误，确保原生函数识别的准确性。
+
🔗 相关提交： 933c9d2
+
+
+
🎯 修复内容：
+
+ - 正确识别原生 C++ 函数
+ - 修复反射调用问题
+ - 提升函数绑定稳定性
+
+
+
+
+
+
+
+
📈 功能统计
+
+
+
+ - ✨ 2 项新功能
+ - ⚡ 1 项性能优化
+ - 🐛 1 个问题修复
+
+
+
+
+
+
+
+
🎯 影响范围
+
+
+
+ - 🏗️ 架构改进
+ - 🔧 开发体验提升
+ - ⚡ 性能优化
+
+
+
+
+
+
+
+
🔮 展望二月
+
+
+
+ - 更多平台支持
+ - 性能进一步优化
+ - 开发工具增强
+
+
+
+
+