次の方法で共有

Create() にコレクション式を使用する (IDE0303)

  • [アーティクル]
プロパティ 値
ルール ID IDE0303
Title Create にコレクション式を使用する
カテゴリ スタイル
Subcategory 言語規則 (式レベル基本設定)
該当言語 C# 12+
[オプション] dotnet_style_prefer_collection_expression

概要

この規則は、(CollectionBuilderAttribute 属性を使って) コレクション構築メソッドとして指定された Create() メソッドまたは同様のメソッドがコレクションの初期化に使われている箇所にフラグを設定し、それをコレクション式 ([...]) に置き換えることを提案します。

Create() メソッドは、変更できないコレクションでよく使われます (例: ImmutableArray.Create(1, 2, 3))。

Note

この規則には、コレクション式パターンをオプトインする、より新しいバージョンの不変 API ( System.Collections.Immutable など) が必要です。

[オプション]

オプションでは、規則を適用する動作を指定します。 オプションの構成の詳細については、「オプションの書式」を参照してください。

dotnet_style_prefer_collection_expression

プロパティ 値 説明
オプション名 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

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

関連項目