Skip to content

Commit a40a919

Browse files
AlianBlankAlianBlank
committed
[增加]1. 补充文档注释
1 parent 4e903bb commit a40a919

8 files changed

Lines changed: 298 additions & 120 deletions

‎Runtime/Web/IWebManager.cs‎

Lines changed: 51 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -3,137 +3,141 @@
33

44
namespace GameFrameX.Web.Runtime
55
{
6+
/// <summary>
7+
/// Web请求管理器接口，提供HTTP GET和POST请求的功能
8+
/// </summary>
69
[UnityEngine.Scripting.Preserve]
710
public interface IWebManager
811
{
912
/// <summary>
10-
/// 发送Get 请求
13+
/// 发送Get请求，返回字符串结果
1114
/// </summary>
1215
/// <param name="url">请求地址</param>
1316
/// <param name="userData">用户自定义数据</param>
14-
/// <returns></returns>
17+
/// <returns>返回WebStringResult类型的异步任务</returns>
1518
Task<WebStringResult> GetToString(string url, object userData = null);
1619

1720
/// <summary>
18-
/// 发送Get 请求
21+
/// 发送Get请求，返回字节数组结果
1922
/// </summary>
2023
/// <param name="url">请求地址</param>
2124
/// <param name="userData">用户自定义数据</param>
22-
/// <returns></returns>
25+
/// <returns>返回WebBufferResult类型的异步任务</returns>
2326
Task<WebBufferResult> GetToBytes(string url, object userData = null);
2427

2528
/// <summary>
26-
/// 发送Get 请求
29+
/// 发送带查询参数的Get请求，返回字符串结果
2730
/// </summary>
2831
/// <param name="url">请求地址</param>
29-
/// <param name="queryString">请求参数</param>
32+
/// <param name="queryString">URL查询参数字典</param>
3033
/// <param name="userData">用户自定义数据</param>
31-
/// <returns></returns>
34+
/// <returns>返回WebStringResult类型的异步任务</returns>
3235
Task<WebStringResult> GetToString(string url, Dictionary<string, string> queryString, object userData = null);
3336

3437

3538
/// <summary>
36-
/// 发送Get 请求
39+
/// 发送带查询参数的Get请求，返回字节数组结果
3740
/// </summary>
3841
/// <param name="url">请求地址</param>
39-
/// <param name="queryString">请求参数</param>
42+
/// <param name="queryString">URL查询参数字典</param>
4043
/// <param name="userData">用户自定义数据</param>
41-
/// <returns></returns>
44+
/// <returns>返回WebBufferResult类型的异步任务</returns>
4245
Task<WebBufferResult> GetToBytes(string url, Dictionary<string, string> queryString, object userData = null);
4346

4447

4548
/// <summary>
46-
/// 发送Get 请求
49+
/// 发送带查询参数和请求头的Get请求，返回字符串结果
4750
/// </summary>
4851
/// <param name="url">请求地址</param>
49-
/// <param name="queryString">请求参数</param>
50-
/// <param name="header">请求头</param>
52+
/// <param name="queryString">URL查询参数字典</param>
53+
/// <param name="header">HTTP请求头字典</param>
5154
/// <param name="userData">用户自定义数据</param>
52-
/// <returns></returns>
55+
/// <returns>返回WebStringResult类型的异步任务</returns>
5356
Task<WebStringResult> GetToString(string url, Dictionary<string, string> queryString, Dictionary<string, string> header, object userData = null);
5457

5558

5659
/// <summary>
57-
/// 发送Get 请求
60+
/// 发送带查询参数和请求头的Get请求，返回字节数组结果
5861
/// </summary>
5962
/// <param name="url">请求地址</param>
60-
/// <param name="queryString">请求参数</param>
61-
/// <param name="header">请求头</param>
63+
/// <param name="queryString">URL查询参数字典</param>
64+
/// <param name="header">HTTP请求头字典</param>
6265
/// <param name="userData">用户自定义数据</param>
63-
/// <returns></returns>
66+
/// <returns>返回WebBufferResult类型的异步任务</returns>
6467
Task<WebBufferResult> GetToBytes(string url, Dictionary<string, string> queryString, Dictionary<string, string> header, object userData = null);
6568

6669

6770
/// <summary>
68-
/// 发送Post 请求
71+
/// 发送简单Post请求，返回字符串结果
6972
/// </summary>
7073
/// <param name="url">请求地址</param>
71-
/// <param name="from">请求参数</param>
74+
/// <param name="from">表单数据字典</param>
7275
/// <param name="userData">用户自定义数据</param>
73-
/// <returns></returns>
76+
/// <returns>返回WebStringResult类型的异步任务</returns>
7477
Task<WebStringResult> PostToString(string url, Dictionary<string, object> from, object userData = null);
7578

7679
/// <summary>
77-
/// 发送Post 请求
80+
/// 发送带查询参数的Post请求，返回字符串结果
7881
/// </summary>
7982
/// <param name="url">请求地址</param>
80-
/// <param name="from">表单请求参数</param>
81-
/// <param name="queryString">URl请求参数</param>
83+
/// <param name="from">表单数据字典</param>
84+
/// <param name="queryString">URL查询参数字典</param>
8285
/// <param name="userData">用户自定义数据</param>
83-
/// <returns></returns>
86+
/// <returns>返回WebStringResult类型的异步任务</returns>
8487
Task<WebStringResult> PostToString(string url, Dictionary<string, object> from, Dictionary<string, string> queryString, object userData = null);
8588

8689
/// <summary>
87-
/// 发送Post 请求
90+
/// 发送带查询参数和请求头的Post请求，返回字符串结果
8891
/// </summary>
8992
/// <param name="url">请求地址</param>
90-
/// <param name="from">表单请求参数</param>
91-
/// <param name="queryString">URl请求参数</param>
92-
/// <param name="header">请求头</param>
93+
/// <param name="from">表单数据字典</param>
94+
/// <param name="queryString">URL查询参数字典</param>
95+
/// <param name="header">HTTP请求头字典</param>
9396
/// <param name="userData">用户自定义数据</param>
94-
/// <returns></returns>
97+
/// <returns>返回WebStringResult类型的异步任务</returns>
9598
Task<WebStringResult> PostToString(string url, Dictionary<string, object> from, Dictionary<string, string> queryString, Dictionary<string, string> header, object userData = null);
9699

97100
/// <summary>
98-
/// 发送Post 请求
101+
/// 发送简单Post请求，返回字节数组结果
99102
/// </summary>
100103
/// <param name="url">请求地址</param>
101-
/// <param name="from">请求参数</param>
104+
/// <param name="from">表单数据字典</param>
102105
/// <param name="userData">用户自定义数据</param>
103-
/// <returns></returns>
106+
/// <returns>返回WebBufferResult类型的异步任务</returns>
104107
Task<WebBufferResult> PostToBytes(string url, Dictionary<string, object> from, object userData = null);
105108

106109
/// <summary>
107-
/// 发送Post 请求
110+
/// 发送带查询参数的Post请求，返回字节数组结果
108111
/// </summary>
109112
/// <param name="url">请求地址</param>
110-
/// <param name="from">表单请求参数</param>
111-
/// <param name="queryString">URl请求参数</param>
113+
/// <param name="from">表单数据字典</param>
114+
/// <param name="queryString">URL查询参数字典</param>
112115
/// <param name="userData">用户自定义数据</param>
113-
/// <returns></returns>
116+
/// <returns>返回WebBufferResult类型的异步任务</returns>
114117
Task<WebBufferResult> PostToBytes(string url, Dictionary<string, object> from, Dictionary<string, string> queryString, object userData = null);
115118

116119
/// <summary>
117-
/// 发送Post 请求
120+
/// 发送带查询参数和请求头的Post请求，返回字节数组结果
118121
/// </summary>
119122
/// <param name="url">请求地址</param>
120-
/// <param name="from">表单请求参数</param>
121-
/// <param name="queryString">URl请求参数</param>
122-
/// <param name="header">请求头</param>
123+
/// <param name="from">表单数据字典</param>
124+
/// <param name="queryString">URL查询参数字典</param>
125+
/// <param name="header">HTTP请求头字典</param>
123126
/// <param name="userData">用户自定义数据</param>
124-
/// <returns></returns>
127+
/// <returns>返回WebBufferResult类型的异步任务</returns>
125128
Task<WebBufferResult> PostToBytes(string url, Dictionary<string, object> from, Dictionary<string, string> queryString, Dictionary<string, string> header, object userData = null);
126129

127130
#if ENABLE_GAME_FRAME_X_WEB_PROTOBUF_NETWORK
128131
/// <summary>
129-
/// 发送Post请求。
132+
/// 发送Protobuf消息的Post请求，并接收指定类型的响应
130133
/// </summary>
131-
/// <param name="url">目标服务器的URL地址。</param>
132-
/// <param name="message">要发送的消息对象，必须继承自MessageObject。</param>
133-
/// <typeparam name="T">返回的数据类型，必须继承自MessageObject并且实现IResponseMessage接口。</typeparam>
134-
/// <returns>返回一个任务对象，该任务完成时将包含从服务器接收到的响应数据，数据类型为T。</returns>
134+
/// <param name="url">目标服务器的URL地址</param>
135+
/// <param name="message">要发送的Protobuf消息对象，必须继承自MessageObject</param>
136+
/// <typeparam name="T">返回的数据类型，必须继承自MessageObject并且实现IResponseMessage接口</typeparam>
137+
/// <returns>返回指定类型T的异步任务，该任务完成时将包含从服务器接收到的响应数据</returns>
135138
/// <remarks>
136139
/// 此方法用于向指定的URL发送POST请求，并接收响应。请求的消息体由参数message提供，而响应则会被解析为指定的泛型类型T。
140+
/// 仅在启用ENABLE_GAME_FRAME_X_WEB_PROTOBUF_NETWORK宏定义时可用。
137141
/// </remarks>
138142
Task<T> Post<T>(string url, GameFrameX.Network.Runtime.MessageObject message) where T : GameFrameX.Network.Runtime.MessageObject, GameFrameX.Network.Runtime.IResponseMessage;
139143

0 commit comments

Comments
 (0)