使用集合初始值设定项或表达式 (IDE0028)

  • 项目
属性 值
规则 ID IDE0028
标题 使用集合初始值设定项
类别 Style
Subcategory 语言规则（表达式级首选项）
适用的语言 C# 和 Visual Basic
选项 dotnet_style_collection_initializer
dotnet_style_prefer_collection_expression

概述

此样式规则涉及使用集合初始值设定项，如果使用 C# 12 或更高版本，则还涉及使用用于集合初始化的集合表达式。

在 .NET 8 (C# 12) 及更高版本中，如果将 dotnet_style_prefer_collection_expression 选项设置为 true，Visual Studio 中的代码修复程序会将集合初始化代码转换为使用集合表达式 (List<int> list = [1, 2, 3];)。 在 Visual Basic 和 .NET 7 (C# 11) 及早期版本中，代码修复程序会将代码转换为使用集合初始值设定项 (List<int> list = new List<int> { 1, 2, 3 };)。

注意

如果在 Visual Studio 中使用代码修复程序，则它提供的更改在某些情况下可能具有不同的语义。 例如，int[] x = new int[] { } 被替换为 int[] x = [];，语义略有不同 - 编译器为 x 使用单一实例而不是创建新实例。

选项

设置此规则的关联选项的值，以指定初始化集合时是否首选集合初始值设定项和集合表达式。

若要详细了解如何配置选项，请参阅选项格式。

dotnet_style_collection_initializer

属性 价值 说明
选项名称 dotnet_style_collection_initializer
选项值 true 首选使用集合初始值设定项。
false 不首选集合初始值设定项。
默认选项值 true

dotnet_style_prefer_collection_expression（仅限 C#）

属性 价值 说明
选项名称 dotnet_style_prefer_collection_expression
选项值 true 首选使用集合表达式。
false 不首选集合表达式。
默认选项值 true

示例

// IDE0028 violation.
List<int> list = new List<int>();
list.Add(1);
list.Add(2);
list.Add(3);

// Fixed code (with dotnet_style_prefer_collection_expression = true)
List<int> list = [1, 2, 3];

' IDE0028 violation.
Dim list = New List(Of Integer)
list.Add(1)
list.Add(2)
list.Add(3)

' Fixed code.
Dim list = New List(Of Integer) From {1, 2, 3}

// IDE0028 violation.
List<int> list = new List<int>();
list.Add(1);
list.Add(2);
list.Add(3);

// Fixed code.
List<int> list = new List<int>
{
    1,
    2,
    3
};

// IDE0028 violation.
List<int> list = new List<int>();
list.Add(1);
list.AddRange(new[] { 5, 6, 7 });

// Fixed code.
List<int> list = [1, .. new[] { 5, 6, 7 }];

' IDE0028 violation.
Dim list = New List(Of Integer)
list.Add(1)
list.Add(2)
list.Add(3)

' Fixed code.
Dim list = New List(Of Integer) From {1, 2, 3}

抑制警告

如果只想抑制单个冲突，请将预处理器指令添加到源文件以禁用该规则，然后重新启用该规则。

#pragma warning disable IDE0028
// The code that's violating the rule is on this line.
#pragma warning restore IDE0028

若要对文件、文件夹或项目禁用该规则，请在配置文件中将其严重性设置为 none。

[*.{cs,vb}]
dotnet_diagnostic.IDE0028.severity = none

若要禁用所有代码样式规则，请在配置文件中将类别 Style 的严重性设置为 none。

[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Style.severity = none

有关详细信息，请参阅如何禁止显示代码分析警告。

另请参阅