空の配列にコレクション式を使用する (IDE0301)

プロパティ
ルール ID IDE0301
Title 空の配列にコレクション式を使用する
カテゴリ スタイル
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 ルールを無効にします。
既定のオプションの値 true (.NET 8)
when_types_loosely_match (.NET 9 以降のバージョン)

*このオプションを使う場合のコード修正により、コードのセマンティクスが変更される可能性があります。

// 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

詳細については、「コード分析の警告を抑制する方法」を参照してください。

関連項目