使用 empty 的集合表达式 (IDE0301)
| 属性 | 值 |
|---|---|
| 规则 ID | IDE0301 |
| 标题 | 使用 empty 的集合表达式 |
| 类别 | Style |
| Subcategory | 语言规则（表达式级首选项） |
| 适用的语言 | C# 12+ |
| 选项 | dotnet_style_prefer_collection_expression |
概述
此规则查找类似于 Array.Empty<T>()（返回空集合的方法调用）或 ImmutableArray<T>.Empty（返回空集合的属性）的代码，并试图将其替换为集合表达式 ([])。
选项
选项指定你希望规则强制实施的行为。 若要了解如何配置选项，请参阅选项格式。
dotnet_style_prefer_collection_expression
| 属性 | 价值 | 说明 |
|---|---|---|
| 选项名称 | dotnet_style_prefer_collection_expression | |
| 选项值 | true | when_types_exactly_match |
只有在类型完全匹配时才首选使用集合表达式，例如 int[] i = Array.Empty<int>();。 |
when_types_loosely_match（.NET 9 及更高版本）* |
即使在类型属于松散匹配的情况下，也首选使用集合表达式，例如 IEnumerable<int> i = Array.Empty<int>();。 目标类型必须与右侧的类型匹配或者是以下类型之一：IEnumerable<T>、ICollection<T>、IList<T>、IReadOnlyCollection<T>、IReadOnlyList<T>。 |
|
false | never |
禁用规则。 | |
| 默认选项值 | .NET 8 中的 true.NET 9 及更高版本中的 when_types_loosely_match |
*使用此选项时进行的代码修复可能会更改代码的语义。
示例
// Code with violations.
int[] i = Array.Empty<int>();
IEnumerable<int> j = Array.Empty<int>();
ReadOnlySpan<int> span = ReadOnlySpan<int>.Empty;
// Fixed code.
int[] i = [];
IEnumerable<int> j = [];
ReadOnlySpan<int> span = [];
以下代码片段显示了一个具有自定义类型的示例。
public class Program
{
public static void Main()
{
// IDE0301 violation.
MyList<int> x = MyList<int>.Empty;
// IDE0301 fixed code.
MyList<int> x = [];
}
}
class MyList<T> : IEnumerable<T>
{
public static MyList<T> Empty { get; }
public IEnumerator<T> GetEnumerator() => default;
IEnumerator IEnumerable.GetEnumerator() => default;
}
抑制警告
如果只想抑制单个冲突，请将预处理器指令添加到源文件以禁用该规则，然后重新启用该规则。
#pragma warning disable IDE0301
// The code that's violating the rule is on this line.
#pragma warning restore IDE0301
若要对文件、文件夹或项目禁用该规则，请在配置文件中将其严重性设置为 none。
[*.{cs,vb}]
dotnet_diagnostic.IDE0301.severity = none
若要禁用所有代码样式规则，请在配置文件中将类别 Style 的严重性设置为 none。
[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Style.severity = none
有关详细信息，请参阅如何禁止显示代码分析警告。
