Skip to content

Commit 8e21b66

Browse files
AlianBlankAlianBlank
committed
docs: 为 SequenceReaderExtensions 添加双语文档注释
为序列读取器扩展方法添加标准的双语文档注释： - TryReadBigEndianValue 系列方法 - 包括 byte、ushort、short、uint、int、ulong、long 等类型的读取方法 统一使用双语格式：summary 中文，remarks 英文，param/returns 双语。
1 parent 98196fd commit 8e21b66

1 file changed

Lines changed: 52 additions & 28 deletions

File tree

‎GameFrameX.Foundation.Extensions/SequenceReaderExtensions.cs‎

Lines changed: 52 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,21 @@ namespace GameFrameX.Foundation.Extensions;
4040
/// <summary>
4141
/// 提供对 <see cref="SequenceReader{T}" /> 类的扩展方法，用于从只读内存中读取数据。
4242
/// </summary>
43+
/// <remarks>
44+
/// Provides extension methods for the <see cref="SequenceReader{T}" /> class for reading data from read-only memory.
45+
/// </remarks>
4346
public static class SequenceReaderExtensions
4447
{
4548
/// <summary>
4649
/// 从只读内存中获取一个字节数据。
4750
/// </summary>
48-
/// <param name="reader">只读内存读取器。</param>
49-
/// <param name="value">结果值。</param>
50-
/// <returns>读取成功返回 True，否则返回 False。</returns>
51-
/// <exception cref="ArgumentException">当读取器无效时抛出。</exception>
51+
/// <remarks>
52+
/// Reads a byte value from the read-only memory.
53+
/// </remarks>
54+
/// <param name="reader">只读内存读取器 / The sequence reader.</param>
55+
/// <param name="value">结果值 / The result value.</param>
56+
/// <returns>读取成功返回 <c>true</c>，否则返回 <c>false</c> / Returns <c>true</c> if read successfully; otherwise <c>false</c>.</returns>
57+
/// <exception cref="ArgumentException">当读取器无效时抛出 / Thrown when the reader is invalid.</exception>
5258
public static bool TryReadBigEndianValue(this ref SequenceReader<byte> reader, out byte value)
5359
{
5460
value = 0;
@@ -64,10 +70,13 @@ public static bool TryReadBigEndianValue(this ref SequenceReader<byte> reader, o
6470
/// <summary>
6571
/// 从只读内存中获取一个无符号短整型数据。
6672
/// </summary>
67-
/// <param name="reader">只读内存读取器。</param>
68-
/// <param name="value">结果值。</param>
69-
/// <returns>读取成功返回 True，否则返回 False。</returns>
70-
/// <exception cref="ArgumentException">当读取器无效时抛出。</exception>
73+
/// <remarks>
74+
/// Reads an unsigned short (UInt16) value from the read-only memory in big-endian format.
75+
/// </remarks>
76+
/// <param name="reader">只读内存读取器 / The sequence reader.</param>
77+
/// <param name="value">结果值 / The result value.</param>
78+
/// <returns>读取成功返回 <c>true</c>，否则返回 <c>false</c> / Returns <c>true</c> if read successfully; otherwise <c>false</c>.</returns>
79+
/// <exception cref="ArgumentException">当读取器无效时抛出 / Thrown when the reader is invalid.</exception>
7180
public static bool TryReadBigEndianValue(this ref SequenceReader<byte> reader, out ushort value)
7281
{
7382
value = 0;
@@ -90,10 +99,13 @@ public static bool TryReadBigEndianValue(this ref SequenceReader<byte> reader, o
9099
/// <summary>
91100
/// 从只读内存中获取一个有符号短整型数据。
92101
/// </summary>
93-
/// <param name="reader">只读内存读取器。</param>
94-
/// <param name="value">结果值。</param>
95-
/// <returns>读取成功返回 True，否则返回 False。</returns>
96-
/// <exception cref="ArgumentException">当读取器无效时抛出。</exception>
102+
/// <remarks>
103+
/// Reads a signed short (Int16) value from the read-only memory in big-endian format.
104+
/// </remarks>
105+
/// <param name="reader">只读内存读取器 / The sequence reader.</param>
106+
/// <param name="value">结果值 / The result value.</param>
107+
/// <returns>读取成功返回 <c>true</c>，否则返回 <c>false</c> / Returns <c>true</c> if read successfully; otherwise <c>false</c>.</returns>
108+
/// <exception cref="ArgumentException">当读取器无效时抛出 / Thrown when the reader is invalid.</exception>
97109
public static bool TryReadBigEndianValue(this ref SequenceReader<byte> reader, out short value)
98110
{
99111
value = 0;
@@ -116,10 +128,13 @@ public static bool TryReadBigEndianValue(this ref SequenceReader<byte> reader, o
116128
/// <summary>
117129
/// 从只读内存中获取一个无符号整型数据。
118130
/// </summary>
119-
/// <param name="reader">只读内存读取器。</param>
120-
/// <param name="value">结果值。</param>
121-
/// <returns>读取成功返回 True，否则返回 False。</returns>
122-
/// <exception cref="ArgumentException">当读取器无效时抛出。</exception>
131+
/// <remarks>
132+
/// Reads an unsigned integer (UInt32) value from the read-only memory in big-endian format.
133+
/// </remarks>
134+
/// <param name="reader">只读内存读取器 / The sequence reader.</param>
135+
/// <param name="value">结果值 / The result value.</param>
136+
/// <returns>读取成功返回 <c>true</c>，否则返回 <c>false</c> / Returns <c>true</c> if read successfully; otherwise <c>false</c>.</returns>
137+
/// <exception cref="ArgumentException">当读取器无效时抛出 / Thrown when the reader is invalid.</exception>
123138
public static bool TryReadBigEndianValue(this ref SequenceReader<byte> reader, out uint value)
124139
{
125140
value = 0;
@@ -142,10 +157,13 @@ public static bool TryReadBigEndianValue(this ref SequenceReader<byte> reader, o
142157
/// <summary>
143158
/// 从只读内存中获取一个有符号整型数据。
144159
/// </summary>
145-
/// <param name="reader">只读内存读取器。</param>
146-
/// <param name="value">结果值。</param>
147-
/// <returns>读取成功返回 True，否则返回 False。</returns>
148-
/// <exception cref="ArgumentException">当读取器无效时抛出。</exception>
160+
/// <remarks>
161+
/// Reads a signed integer (Int32) value from the read-only memory in big-endian format.
162+
/// </remarks>
163+
/// <param name="reader">只读内存读取器 / The sequence reader.</param>
164+
/// <param name="value">结果值 / The result value.</param>
165+
/// <returns>读取成功返回 <c>true</c>，否则返回 <c>false</c> / Returns <c>true</c> if read successfully; otherwise <c>false</c>.</returns>
166+
/// <exception cref="ArgumentException">当读取器无效时抛出 / Thrown when the reader is invalid.</exception>
149167
public static bool TryReadBigEndianValue(this ref SequenceReader<byte> reader, out int value)
150168
{
151169
value = 0;
@@ -168,10 +186,13 @@ public static bool TryReadBigEndianValue(this ref SequenceReader<byte> reader, o
168186
/// <summary>
169187
/// 从只读内存中获取一个无符号长整型数据。
170188
/// </summary>
171-
/// <param name="reader">只读内存读取器。</param>
172-
/// <param name="value">结果值。</param>
173-
/// <returns>读取成功返回 True，否则返回 False。</returns>
174-
/// <exception cref="ArgumentException">当读取器无效时抛出。</exception>
189+
/// <remarks>
190+
/// Reads an unsigned long (UInt64) value from the read-only memory in big-endian format.
191+
/// </remarks>
192+
/// <param name="reader">只读内存读取器 / The sequence reader.</param>
193+
/// <param name="value">结果值 / The result value.</param>
194+
/// <returns>读取成功返回 <c>true</c>，否则返回 <c>false</c> / Returns <c>true</c> if read successfully; otherwise <c>false</c>.</returns>
195+
/// <exception cref="ArgumentException">当读取器无效时抛出 / Thrown when the reader is invalid.</exception>
175196
public static bool TryReadBigEndianValue(this ref SequenceReader<byte> reader, out ulong value)
176197
{
177198
value = 0;
@@ -194,10 +215,13 @@ public static bool TryReadBigEndianValue(this ref SequenceReader<byte> reader, o
194215
/// <summary>
195216
/// 从只读内存中获取一个有符号长整型数据。
196217
/// </summary>
197-
/// <param name="reader">只读内存读取器。</param>
198-
/// <param name="value">结果值。</param>
199-
/// <returns>读取成功返回 True，否则返回 False。</returns>
200-
/// <exception cref="ArgumentException">当读取器无效时抛出。</exception>
218+
/// <remarks>
219+
/// Reads a signed long (Int64) value from the read-only memory in big-endian format.
220+
/// </remarks>
221+
/// <param name="reader">只读内存读取器 / The sequence reader.</param>
222+
/// <param name="value">结果值 / The result value.</param>
223+
/// <returns>读取成功返回 <c>true</c>，否则返回 <c>false</c> / Returns <c>true</c> if read successfully; otherwise <c>false</c>.</returns>
224+
/// <exception cref="ArgumentException">当读取器无效时抛出 / Thrown when the reader is invalid.</exception>
201225
public static bool TryReadBigEndianValue(this ref SequenceReader<byte> reader, out long value)
202226
{
203227
value = 0;

0 commit comments

Comments
 (0)