Skip to content

Commit 209d68a

Browse files
committed
docs: 为 ArgumentAlreadyException 添加英文注释
更新 XML 文档注释,为类、构造函数及方法添加英文说明,并修正标点符号。
1 parent ed073d5 commit 209d68a

1 file changed

Lines changed: 20 additions & 11 deletions

File tree

GameFrameX.Foundation.Extensions/ArgumentAlreadyException.cs

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -34,29 +34,38 @@
3434
namespace GameFrameX.Foundation.Extensions;
3535

3636
/// <summary>
37-
/// 已经存在参数重复异常
38-
/// 用于表示当参数值已经存在或重复时抛出的异常
37+
/// 已经存在参数重复异常
38+
/// 用于表示当参数值已经存在或重复时抛出的异常
3939
/// </summary>
40+
/// <remarks>
41+
/// Exception thrown when an argument value already exists or is duplicated.
42+
/// </remarks>
4043
public sealed class ArgumentAlreadyException : Exception
4144
{
4245
/// <summary>
43-
/// 已经存在参数重复异常构造函数
46+
/// 已经存在参数重复异常构造函数
4447
/// </summary>
45-
/// <param name="message">异常消息,描述具体的参数重复问题,不能为 null、空字符串或仅包含空白字符</param>
46-
/// <exception cref="ArgumentNullException">当 <paramref name="message"/> 为 null 时抛出</exception>
47-
/// <exception cref="ArgumentException">当 <paramref name="message"/> 为空字符串或仅包含空白字符时抛出</exception>
48+
/// <remarks>
49+
/// Initializes a new instance of the <see cref="ArgumentAlreadyException"/> class with a specified error message.
50+
/// </remarks>
51+
/// <param name="message">异常消息,描述具体的参数重复问题,不能为 null、空字符串或仅包含空白字符 / The message that describes the error, cannot be null, empty, or whitespace.</param>
52+
/// <exception cref="ArgumentNullException">当 <paramref name="message"/> 为 null 时抛出 / Thrown when <paramref name="message"/> is null.</exception>
53+
/// <exception cref="ArgumentException">当 <paramref name="message"/> 为空字符串或仅包含空白字符时抛出 / Thrown when <paramref name="message"/> is empty or whitespace.</exception>
4854
public ArgumentAlreadyException(string message) : base(message)
4955
{
5056
ArgumentException.ThrowIfNullOrWhiteSpace(message, nameof(message));
5157
}
5258

5359
/// <summary>
54-
/// 抛出参数重复异常的静态辅助方法
60+
/// 抛出参数重复异常的静态辅助方法
5561
/// </summary>
56-
/// <param name="message">异常消息,描述具体的参数重复问题,不能为 null、空字符串或仅包含空白字符</param>
57-
/// <exception cref="ArgumentNullException">当 <paramref name="message"/> 为 null 时抛出</exception>
58-
/// <exception cref="ArgumentException">当 <paramref name="message"/> 为空字符串或仅包含空白字符时抛出</exception>
59-
/// <exception cref="ArgumentAlreadyException">当调用此方法时总是抛出此异常</exception>
62+
/// <remarks>
63+
/// Throws an <see cref="ArgumentAlreadyException"/> with the specified message.
64+
/// </remarks>
65+
/// <param name="message">异常消息,描述具体的参数重复问题,不能为 null、空字符串或仅包含空白字符 / The message that describes the error, cannot be null, empty, or whitespace.</param>
66+
/// <exception cref="ArgumentNullException">当 <paramref name="message"/> 为 null 时抛出 / Thrown when <paramref name="message"/> is null.</exception>
67+
/// <exception cref="ArgumentException">当 <paramref name="message"/> 为空字符串或仅包含空白字符时抛出 / Thrown when <paramref name="message"/> is empty or whitespace.</exception>
68+
/// <exception cref="ArgumentAlreadyException">当调用此方法时总是抛出此异常 / Always thrown when this method is called.</exception>
6069
public static void Throw(string message)
6170
{
6271
ArgumentException.ThrowIfNullOrWhiteSpace(message, nameof(message));

0 commit comments

Comments
 (0)