Skip to content

Commit 98196fd

Browse files
committed
docs: 为 NullableDictionary 添加双语文档注释
为 NullableDictionary 及相关类型添加标准的双语文档注释: - FallbackValue<TValue> 结构体 - NullableDictionary<TKey, TValue> 类 包括构造函数、属性、方法的完整双语注释。
1 parent b103c4d commit 98196fd

1 file changed

Lines changed: 27 additions & 12 deletions

File tree

GameFrameX.Foundation.Extensions/NullableDictionary.cs

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,42 +36,57 @@
3636
namespace GameFrameX.Foundation.Extensions;
3737

3838
/// <summary>
39-
/// 用于明确指定 NullableDictionary 的 fallback 值的包装类型
39+
/// 用于明确指定 NullableDictionary 的 fallback 值的包装类型
4040
/// </summary>
41-
/// <typeparam name="TValue">值的类型</typeparam>
41+
/// <remarks>
42+
/// A wrapper type used to explicitly specify the fallback value for NullableDictionary.
43+
/// </remarks>
44+
/// <typeparam name="TValue">值的类型 / The type of the value.</typeparam>
4245
public readonly struct FallbackValue<TValue>
4346
{
4447
/// <summary>
45-
/// 获取包装的值
48+
/// 获取包装的值
4649
/// </summary>
47-
/// <value>包装的泛型类型 T 的值</value>
50+
/// <remarks>
51+
/// Gets the wrapped value.
52+
/// </remarks>
53+
/// <value>包装的泛型类型 T 的值 / The wrapped value of type T.</value>
4854
public TValue Value { get; }
4955

5056
/// <summary>
51-
/// 初始化一个包含指定值的 FallbackValue
57+
/// 初始化一个包含指定值的 FallbackValue
5258
/// </summary>
53-
/// <param name="value"></param>
59+
/// <remarks>
60+
/// Initializes a new instance of the <see cref="FallbackValue{TValue}"/> struct with the specified value.
61+
/// </remarks>
62+
/// <param name="value">要包装的值 / The value to wrap.</param>
5463
public FallbackValue(TValue value)
5564
{
5665
Value = value;
5766
}
5867

5968
/// <summary>
60-
/// 将 TValue 转换为 FallbackValue
69+
/// 将 TValue 隐式转换为 FallbackValue
6170
/// </summary>
62-
/// <param name="value"></param>
63-
/// <returns></returns>
71+
/// <remarks>
72+
/// Implicitly converts a value of type TValue to a <see cref="FallbackValue{TValue}"/>.
73+
/// </remarks>
74+
/// <param name="value">要转换的值 / The value to convert.</param>
75+
/// <returns>一个包含指定值的 FallbackValue 实例 / A <see cref="FallbackValue{TValue}"/> instance containing the specified value.</returns>
6476
public static implicit operator FallbackValue<TValue>(TValue value)
6577
{
6678
return new FallbackValue<TValue>(value);
6779
}
6880
}
6981

7082
/// <summary>
71-
/// 可空字典,支持 null 键和自定义默认值
83+
/// 可空字典,支持 null 键和自定义默认值
7284
/// </summary>
73-
/// <typeparam name="TKey">键的类型</typeparam>
74-
/// <typeparam name="TValue">值的类型</typeparam>
85+
/// <remarks>
86+
/// A dictionary that supports null keys and custom default values.
87+
/// </remarks>
88+
/// <typeparam name="TKey">键的类型 / The type of the keys in the dictionary.</typeparam>
89+
/// <typeparam name="TValue">值的类型 / The type of the values in the dictionary.</typeparam>
7590
public class NullableDictionary<TKey, TValue> : Dictionary<NullObject<TKey>, TValue>
7691
{
7792
/// <summary>

0 commit comments

Comments
 (0)