閱讀英文版本

分享方式:


使用集合表示式來處理空集合(IDE0301)

財產 價值
規則標識碼 IDE0301
標題 針對空白使用集合表達式
類別 風格
子類別 語言規則(表達層級喜好設定)
適用的語言 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

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

C#
// 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 = [];

下列代碼段顯示具有自定義類型的範例。

C#
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;
}

隱藏警告

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

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

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

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

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

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

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

另請參閱