針對 使用集合表示式 Create() （IDE0303）

  • 發行項
屬性 值
規則識別碼 IDE0303
標題 使用建立的集合表達式
類別 樣式
子類別 語言規則 （運算式層級喜好設定）
適用語言 C# 12+
選項 dotnet_style_prefer_collection_expression

概觀

此規則旗標會放置 Create() 指定為集合建構方法的方法或類似方法的位置（使用 CollectionBuilderAttribute 屬性）來初始化集合，並提供 將它取代為 集合表達式 （[...]）。

Create() 方法對於不可變的集合很常見，例如 ImmutableArray.Create(1, 2, 3)。

注意

此規則需要較新版本的不可變 API（例如， System.Collections.Immutable），以加入加入集合運算式模式。

選項。

選項會指定您希望規則強制執行的行為。 如需設定選項的相關信息，請參閱 選項格式。

dotnet_style_prefer_collection_expression

屬性 數值 Description
選項名稱 dotnet_style_prefer_collection_expression
選項值 true | when_types_exactly_match 只有在類型完全相符時，才偏好使用集合表示式，例如 ImmutableArray<int> i = ImmutableArray.Create(1, 2, 3);。
when_types_loosely_match
（.NET 9 和更新版本）*		 偏好使用集合表示式，即使類型比對鬆散，例如 IEnumerable<int> i = ImmutableArray.Create(1, 2, 3);。 目標型別必須符合右側的類型，或是下列其中一種類型：IEnumerable<T>、、ICollection<T>、IList<T>、IReadOnlyCollection<T>IReadOnlyList<T>、 。
false | never 停用規則。
默認選項值 true 在 .NET 8 中
when_types_loosely_match 在 .NET 9 和更新版本中

*使用此選項時的程式代碼修正可能會變更程式碼的語意。

範例

// Code with violations.
ImmutableArray<int> i = ImmutableArray.Create(1, 2, 3);
IEnumerable<int> j = ImmutableArray.Create(1, 2, 3);

// Fixed code.
ImmutableArray<int> i = [1, 2, 3];
IEnumerable<int> j = [1, 2, 3];

下列代碼段顯示具有以標註 CollectionBuilderAttribute之自定義類型的範例。

public class Program
{
    public static void Main()
    {
        // IDE0303 violation.
        MyCollection<int> c = MyCollection.Create(1, 2, 3);

        // IDE0303 fixed code.
        MyCollection<int> c = [1, 2, 3];
    }
}

static partial class MyCollection
{
    public static MyCollection<T> Create<T>(System.ReadOnlySpan<T> values) => default;
    public static MyCollection<T> Create<T>(T t1, T t2, T t3) => default;
}

[CollectionBuilder(typeof(MyCollection), "Create")]
class MyCollection<T> : IEnumerable<T>
{
    public IEnumerator<T> GetEnumerator() => default;
    IEnumerator IEnumerable.GetEnumerator() => default;
}

隱藏警告

如果您想要只隱藏單一違規，請將預處理器指示詞新增至原始程式檔以停用，然後重新啟用規則。

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

若要停用檔案、資料夾或項目的規則，請在組態檔中將其嚴重性設定為 。none

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

若要停用所有程式代碼樣式規則，請將組態檔中類別Style的嚴重性設定為 none。

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

如需詳細資訊，請參閱 如何隱藏程式代碼分析警告。

另請參閱