Skip to content

Commit 1326026

Browse files
AlianBlankAlianBlank
committed
docs(Editor): 为小游戏宏定义帮助类添加XML注释
添加XML注释以提升代码文档化程度，方便开发者理解各平台宏定义的作用和使用方法。
1 parent 5fa11fe commit 1326026

7 files changed

Lines changed: 96 additions & 1 deletion

‎Editor/MiniGame/MiniGameDefineSymbolHelper.Alipay.cs‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,16 @@ namespace GameFrameX.Editor
77
{
88
public static partial class MiniGameDefineSymbolHelper
99
{
10+
/// <summary>
11+
/// 支付宝小游戏适配宏定义集合。
12+
/// Define symbols for Alipay mini game adaptation.
13+
/// </summary>
1014
public static readonly string[] EnableAlipayMiniGameScriptingDefineSymbol = new[] { "ENABLE_ALIPAY_MINI_GAME", "ALIPAYMINIGAME" };
1115

16+
/// <summary>
17+
/// 开启支付宝小游戏适配宏定义。
18+
/// Enables define symbols for Alipay mini game adaptation.
19+
/// </summary>
1220
#if UNITY_WEBGL
1321
[MenuItem("GameFrameX/Scripting Define Symbols/Enable Alipay Mini Game(开启[支付宝小游戏]适配)", false, 2400)]
1422
#endif
@@ -31,6 +39,10 @@ public static void EnableAlipayMiniGame()
3139
#endif
3240
}
3341

42+
/// <summary>
43+
/// 关闭支付宝小游戏适配宏定义。
44+
/// Disables define symbols for Alipay mini game adaptation.
45+
/// </summary>
3446
#if UNITY_WEBGL
3547
[MenuItem("GameFrameX/Scripting Define Symbols/Disable Alipay Mini Game(关闭[支付宝小游戏]适配)", false, 2401)]
3648
#endif

‎Editor/MiniGame/MiniGameDefineSymbolHelper.Baidu.cs‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,16 @@ namespace GameFrameX.Editor
77
{
88
public static partial class MiniGameDefineSymbolHelper
99
{
10+
/// <summary>
11+
/// 百度小游戏适配宏定义集合。
12+
/// Define symbols for Baidu mini game adaptation.
13+
/// </summary>
1014
public static readonly string[] EnableBaiduMiniGameScriptingDefineSymbol = new[] { "ENABLE_BAIDU_MINI_GAME", "BAIDUMINIGAME" };
1115

16+
/// <summary>
17+
/// 开启百度小游戏适配宏定义。
18+
/// Enables define symbols for Baidu mini game adaptation.
19+
/// </summary>
1220
#if UNITY_WEBGL
1321
[MenuItem("GameFrameX/Scripting Define Symbols/Enable Baidu Mini Game(开启[百度小游戏]适配)", false, 2300)]
1422
#endif
@@ -31,6 +39,10 @@ public static void EnableBaiduMiniGame()
3139
#endif
3240
}
3341

42+
/// <summary>
43+
/// 关闭百度小游戏适配宏定义。
44+
/// Disables define symbols for Baidu mini game adaptation.
45+
/// </summary>
3446
#if UNITY_WEBGL
3547
[MenuItem("GameFrameX/Scripting Define Symbols/Disable Baidu Mini Game(关闭[百度小游戏]适配)", false, 2301)]
3648
#endif

‎Editor/MiniGame/MiniGameDefineSymbolHelper.DouYin.cs‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,16 @@ namespace GameFrameX.Editor
77
{
88
public static partial class MiniGameDefineSymbolHelper
99
{
10+
/// <summary>
11+
/// 抖音小游戏适配宏定义集合。
12+
/// Define symbols for DouYin mini game adaptation.
13+
/// </summary>
1014
public static readonly string[] EnableDouYinMiniGameScriptingDefineSymbol = new[] { "ENABLE_DOUYIN_MINI_GAME", "DOUYINMINIGAME", "TTSDK_MIX_ENGINE" };
1115

16+
/// <summary>
17+
/// 开启抖音小游戏适配宏定义。
18+
/// Enables define symbols for DouYin mini game adaptation.
19+
/// </summary>
1220
#if UNITY_WEBGL
1321
[MenuItem("GameFrameX/Scripting Define Symbols/Enable DouYin Mini Game(开启[抖音小游戏]适配)", false, 2100)]
1422
#endif
@@ -31,6 +39,10 @@ public static void EnableDouYinMiniGame()
3139
#endif
3240
}
3341

42+
/// <summary>
43+
/// 关闭抖音小游戏适配宏定义。
44+
/// Disables define symbols for DouYin mini game adaptation.
45+
/// </summary>
3446
#if UNITY_WEBGL
3547
[MenuItem("GameFrameX/Scripting Define Symbols/Disable DouYin Mini Game(关闭[抖音小游戏]适配)", false, 2101)]
3648
#endif

‎Editor/MiniGame/MiniGameDefineSymbolHelper.KuaiShou.cs‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,16 @@ namespace GameFrameX.Editor
77
{
88
public static partial class MiniGameDefineSymbolHelper
99
{
10+
/// <summary>
11+
/// 快手小游戏适配宏定义集合。
12+
/// Define symbols for KuaiShou mini game adaptation.
13+
/// </summary>
1014
public static readonly string[] EnableKuaiShouMiniGameScriptingDefineSymbol = new[] { "ENABLE_KUAISHOU_MINI_GAME", "KUAISHOUMINIGAME" };
1115

16+
/// <summary>
17+
/// 开启快手小游戏适配宏定义。
18+
/// Enables define symbols for KuaiShou mini game adaptation.
19+
/// </summary>
1220
#if UNITY_WEBGL
1321
[MenuItem("GameFrameX/Scripting Define Symbols/Enable KuaiShou Mini Game(开启[快手小游戏]适配)", false, 2200)]
1422
#endif
@@ -31,6 +39,10 @@ public static void EnableKuaiShouMiniGame()
3139
#endif
3240
}
3341

42+
/// <summary>
43+
/// 关闭快手小游戏适配宏定义。
44+
/// Disables define symbols for KuaiShou mini game adaptation.
45+
/// </summary>
3446
#if UNITY_WEBGL
3547
[MenuItem("GameFrameX/Scripting Define Symbols/Disable KuaiShou Mini Game(关闭[快手小游戏]适配)", false, 2201)]
3648
#endif

‎Editor/MiniGame/MiniGameDefineSymbolHelper.TapTap.cs‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,16 @@ namespace GameFrameX.Editor
77
{
88
public static partial class MiniGameDefineSymbolHelper
99
{
10+
/// <summary>
11+
/// TapTap 小游戏适配宏定义集合。
12+
/// Define symbols for TapTap mini game adaptation.
13+
/// </summary>
1014
public static readonly string[] EnableTapTapMiniGameScriptingDefineSymbol = new[] { "ENABLE_TAPTAP_MINI_GAME", "TAPTAPMINIGAME" };
1115

16+
/// <summary>
17+
/// 开启 TapTap 小游戏适配宏定义。
18+
/// Enables define symbols for TapTap mini game adaptation.
19+
/// </summary>
1220
#if UNITY_WEBGL
1321
[MenuItem("GameFrameX/Scripting Define Symbols/Enable TapTap Mini Game(开启[TapTap小游戏]适配)", false, 2500)]
1422
#endif
@@ -31,6 +39,10 @@ public static void EnableTapTapMiniGame()
3139
#endif
3240
}
3341

42+
/// <summary>
43+
/// 关闭 TapTap 小游戏适配宏定义。
44+
/// Disables define symbols for TapTap mini game adaptation.
45+
/// </summary>
3446
#if UNITY_WEBGL
3547
[MenuItem("GameFrameX/Scripting Define Symbols/Disable TapTap Mini Game(关闭[TapTap小游戏]适配)", false, 2501)]
3648
#endif

‎Editor/MiniGame/MiniGameDefineSymbolHelper.WeChat.cs‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,16 @@ namespace GameFrameX.Editor
77
{
88
public static partial class MiniGameDefineSymbolHelper
99
{
10+
/// <summary>
11+
/// 微信小游戏适配宏定义集合。
12+
/// Define symbols for WeChat mini game adaptation.
13+
/// </summary>
1014
public static readonly string[] EnableWeChatMiniGameScriptingDefineSymbol = new[] { "ENABLE_WECHAT_MINI_GAME", "WEIXINMINIGAME" };
1115

16+
/// <summary>
17+
/// 开启微信小游戏适配宏定义。
18+
/// Enables define symbols for WeChat mini game adaptation.
19+
/// </summary>
1220
#if UNITY_WEBGL
1321
[MenuItem("GameFrameX/Scripting Define Symbols/Enable WeChat Mini Game(开启[微信小游戏]适配)", false, 2000)]
1422
#endif
@@ -31,6 +39,10 @@ public static void EnableWeChatMiniGame()
3139
#endif
3240
}
3341

42+
/// <summary>
43+
/// 关闭微信小游戏适配宏定义。
44+
/// Disables define symbols for WeChat mini game adaptation.
45+
/// </summary>
3446
#if UNITY_WEBGL
3547
[MenuItem("GameFrameX/Scripting Define Symbols/Disable WeChat Mini Game(关闭[微信小游戏]适配)", false, 2001)]
3648
#endif

‎Editor/MiniGame/MiniGameDefineSymbolHelper.cs‎

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,22 @@
55
namespace GameFrameX.Editor
66
{
77
/// <summary>
8-
/// 小游戏宏定义帮助类
8+
/// 小游戏宏定义帮助类。
9+
/// Mini game scripting define symbol helper.
910
/// </summary>
1011
public static partial class MiniGameDefineSymbolHelper
1112
{
13+
/// <summary>
14+
/// WebGL 小游戏统一宏定义。
15+
/// Unified scripting define symbol for WebGL mini games.
16+
/// </summary>
1217
private const string EnableWebGLMiniGameScriptingDefineSymbol = "ENABLE_WEBGL_MINI_GAME";
1318

19+
/// <summary>
20+
/// 获取所有小游戏平台宏定义集合。
21+
/// Gets all mini game platform define symbol arrays.
22+
/// </summary>
23+
/// <returns>小游戏平台宏定义数组集合 / Collection of mini game define symbol arrays.</returns>
1424
private static string[][] GetAllMiniGameScriptingDefineSymbols()
1525
{
1626
return new[]
@@ -24,6 +34,11 @@ private static string[][] GetAllMiniGameScriptingDefineSymbols()
2434
};
2535
}
2636

37+
/// <summary>
38+
/// 关闭除当前平台以外的其它小游戏平台宏定义。
39+
/// Disables define symbols of other mini game platforms except the current one.
40+
/// </summary>
41+
/// <param name="currentMiniGameScriptingDefineSymbols">当前平台宏定义集合 / Define symbols of the current platform.</param>
2742
private static void DisableOtherMiniGameScriptingDefineSymbols(string[] currentMiniGameScriptingDefineSymbols)
2843
{
2944
#if UNITY_WEBGL
@@ -57,6 +72,10 @@ private static void DisableOtherMiniGameScriptingDefineSymbols(string[] currentM
5772
#endif
5873
}
5974

75+
/// <summary>
76+
/// 打开 WebGL 小游戏统一宏定义。
77+
/// Enables the unified WebGL mini game define symbol.
78+
/// </summary>
6079
private static void EnableUnifiedMiniGameScriptingDefineSymbol()
6180
{
6281
#if UNITY_WEBGL
@@ -70,6 +89,10 @@ private static void EnableUnifiedMiniGameScriptingDefineSymbol()
7089
#endif
7190
}
7291

92+
/// <summary>
93+
/// 根据当前各平台宏定义状态刷新 WebGL 小游戏统一宏定义。
94+
/// Refreshes the unified WebGL mini game define symbol according to platform define states.
95+
/// </summary>
7396
private static void RefreshUnifiedMiniGameScriptingDefineSymbol()
7497
{
7598
#if UNITY_WEBGL

0 commit comments

Comments
 (0)