Skip to content

Commit 50b716b

Browse files
committed
[修改] 标记的注释
1 parent 5b61752 commit 50b716b

2 files changed

Lines changed: 22 additions & 5 deletions

File tree

Runtime/Attribute/OptionUIConfig.cs

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,29 @@
88

99
namespace GameFrameX.UI.Runtime
1010
{
11+
/// <summary>
12+
/// 用于标记 UI 配置的特性类,支持 FairyGUI 和 UGUI 两种 UI 框架。
13+
/// 通过指定包名或路径,实现 UI 资源的自动定位和加载。
14+
/// </summary>
1115
[AttributeUsage(AttributeTargets.Class)]
1216
public sealed class OptionUIConfig : Attribute
1317
{
1418
/// <summary>
15-
/// 包名 FairyGUI 使用
19+
/// FairyGUI 使用的包名。用于定位 FairyGUI 的 UI 资源包。
1620
/// </summary>
1721
public string PackageName { get; private set; }
1822

1923
/// <summary>
20-
/// 路径 UGUI 使用
24+
/// UGUI 使用的资源路径。用于定位 UGUI 的 UI 预制体或资源。
2125
/// </summary>
2226
public string Path { get; private set; }
2327

2428
/// <summary>
25-
///
29+
/// 构造 UI 配置特性。
2630
/// </summary>
27-
/// <param name="packageName"></param>
28-
/// <param name="path"></param>
31+
/// <param name="packageName">FairyGUI 使用的包名,若为 null 则不使用 FairyGUI。</param>
32+
/// <param name="path">UGUI 使用的资源路径,若为 null 则不使用 UGUI。</param>
33+
/// <exception cref="Exception">当 packageName 和 path 均为 null 或空字符串时抛出异常。</exception>
2934
public OptionUIConfig(string packageName = null, string path = null)
3035
{
3136
PackageName = packageName;

Runtime/Attribute/OptionUIGroup.cs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,23 @@
88

99
namespace GameFrameX.UI.Runtime
1010
{
11+
/// <summary>
12+
/// 用于为类指定 UI 选项分组的特性。
13+
/// 只能应用于类,分组名称不能为空。
14+
/// </summary>
1115
[AttributeUsage(AttributeTargets.Class)]
1216
public sealed class OptionUIGroup : Attribute
1317
{
18+
/// <summary>
19+
/// 分组名称
20+
/// </summary>
1421
public string GroupName { get; private set; }
1522

23+
/// <summary>
24+
/// 构造函数,初始化分组名称
25+
/// </summary>
26+
/// <param name="groupName">分组名称,不能为空</param>
27+
/// <exception cref="Exception">分组名称为空时抛出异常</exception>
1628
public OptionUIGroup(string groupName)
1729
{
1830
GroupName = groupName;

0 commit comments

Comments
 (0)