使用生成器的集合表达式 (IDE0304)
属性 | 值 |
---|---|
规则 ID | IDE0304 |
标题 | 使用生成器的集合表达式 |
类别 | Style |
Subcategory | 语言规则(表达式级首选项) |
适用的语言 | C# 12+ |
选项 | dotnet_style_prefer_collection_expression |
概述
此规则标记调用 CreateBuilder()
或类似方法的位置,以创建将添加元素并最终构造具有 CollectionBuilderAttribute 属性的集合类型的生成器类型(例如,通过调用 ImmutableArray<T>.Builder.ToImmutable())。 相反,可以使用集合表达式 ([...]
) 来初始化集合。
注意
此规则需要更新版本的不可变 API(例如 System.Collections.Immutable,选择加入集合表达式模式)。
选项
选项指定你希望规则强制实施的行为。 若要了解如何配置选项,请参阅选项格式。
dotnet_style_prefer_collection_expression
属性 | 价值 | 说明 |
---|---|---|
选项名称 | dotnet_style_prefer_collection_expression | |
选项值 | true | when_types_exactly_match |
只有在类型完全匹配时才首选使用集合表达式。 |
when_types_loosely_match (.NET 9 及更高版本)* |
即使在类型属于松散匹配的情况下,也首选使用集合表达式。 目标类型必须与右侧的类型匹配或者是以下类型之一:IEnumerable<T>、ICollection<T>、IList<T>、IReadOnlyCollection<T>、IReadOnlyList<T>。 | |
false | never |
禁用规则。 | |
默认选项值 | .NET 8 中的 true .NET 9 及更高版本中的 when_types_loosely_match |
*使用此选项时进行的代码修复可能会更改代码的语义。
示例
// Code with violation.
var builder = ImmutableArray.CreateBuilder<int>();
builder.Add(1);
builder.AddRange(new int[] { 5, 6, 7 });
ImmutableArray<int> i = builder.ToImmutable();
// Fixed code.
ImmutableArray<int> i = [1, .. new int[] { 5, 6, 7 }];
抑制警告
如果只想抑制单个冲突,请将预处理器指令添加到源文件以禁用该规则,然后重新启用该规则。
#pragma warning disable IDE0304
// The code that's violating the rule is on this line.
#pragma warning restore IDE0304
若要对文件、文件夹或项目禁用该规则,请在配置文件中将其严重性设置为 none
。
[*.{cs,vb}]
dotnet_diagnostic.IDE0304.severity = none
若要禁用所有代码样式规则,请在配置文件中将类别 Style
的严重性设置为 none
。
[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Style.severity = none
有关详细信息,请参阅如何禁止显示代码分析警告。