Skip to content

Commit 1477d39

Browse files
committed
docs(ProtoExport): 更新接口注释以更清晰地描述参数用途
修改 IProtoGenerateHelper 接口方法的注释,使其更准确地描述参数的作用和默认值
1 parent c531e49 commit 1477d39

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

ProtoExport/IProtoGenerateHelper.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@ namespace GameFrameX.ProtoExport
66
internal interface IProtoGenerateHelper
77
{
88
/// <summary>
9-
/// 开始生成
9+
/// 开始生成协议代码
1010
/// </summary>
11-
/// <param name="inputPath">输入目录</param>
12-
/// <param name="outputPath">输出目录</param>
13-
/// <param name="namespaceName">命名空间</param>
11+
/// <param name="inputPath">包含协议定义的 MessageInfoList 实例</param>
12+
/// <param name="outputPath">生成代码文件的输出目录</param>
13+
/// <param name="namespaceName">生成代码所使用的命名空间,默认值为 "GFXHotfix"</param>
1414
void Run(MessageInfoList inputPath, string outputPath, string namespaceName = "GFXHotfix");
1515

1616
/// <summary>
17-
/// 生成后处理
17+
/// 协议生成后的统一后处理逻辑
1818
/// </summary>
19-
/// <param name="operationCodeInfo"></param>
20-
/// <param name="launcherOptionsOutputPath"></param>
21-
void Post(List<MessageInfoList> operationCodeInfo, string launcherOptionsOutputPath);
19+
/// <param name="operationCodeInfo">待处理的协议信息列表</param>
20+
/// <param name="launcherOptions">启动时配置选项</param>
21+
void Post(List<MessageInfoList> operationCodeInfo, LauncherOptions launcherOptions);
2222
}
2323
}

0 commit comments

Comments
 (0)