CA1863: 'CompositeFormat' kullanın

Özellik	Değer
Kural Kimliği	CA1863
Başlık	CompositeFormat komutunu kullanma
Kategori	Performans
Düzeltme bozucu ya da bozmayan olabilir	Kesintisiz
.NET 10'da varsayılan olarak etkin	Hayır
Geçerli diller	C# ve Visual Basic

Neden

Kod, bir static biçim dizesi ve önbelleğe alınmamış bir CompositeFormat örneğiyle String.Format(String, Object[]) veya StringBuilder.AppendFormat(String, Object[]) çağrıları yapar.

Kural açıklaması

Bir biçim dizesini çalışma zamanında ayrıştırmak pahalıdır. Bu kural, özgün biçim dizesini bağımsız değişken olarak geçirmek yerine, bir CompositeFormat örneğini önbelleğe alıp biçimlendirme işlemlerinde kullanabileceğiniz kod yerlerini bulur. CompositeFormat nesnesi, bileşik biçim dizesini oluşturulduğunda ayrıştırır; bu, dize biçimlendirmesinin "yoğun kullanım yolu"nun çok daha hızlı çalışabileceği anlamına gelir.

İhlalleri düzeltme

CompositeFormat örneği oluşturmak için CompositeFormat.Parse(String) çağırın ve elde edilen değer ile String.Format(IFormatProvider, CompositeFormat, Object[]) veya StringBuilder.AppendFormat(IFormatProvider, CompositeFormat, Object[]) öğesine geçirin, özgün biçim dizesi yerine.

Örnek

Aşağıdaki örnekte kuralın iki ihlali gösterilmektedir:

class C
{
    private static readonly string StaticField = "Format one value: {0}";

    static void Main()
    {
        _ = string.Format(StaticField, 42);

        StringBuilder sb = new();
        sb.AppendFormat(StaticField, 42);
    }
}

Aşağıdaki örnekte her iki ihlali de düzelten kod gösterilmektedir:

class C
{
    private static readonly CompositeFormat StaticField = CompositeFormat.Parse("Format one value: {0}");

    static void Main()
    {
        _ = string.Format(null, StaticField, 42);

        StringBuilder sb = new();
        sb.AppendFormat(null, StaticField, 42);
    }
}

Uyarıların ne zaman bastırılması gerekiyor?

Performans önemli değilse bu kuraldan tanılamayı engellemek güvenlidir.

Uyarıyı gizleme

Yalnızca tek bir ihlali engellemek istiyorsanız, kuralı devre dışı bırakmak ve sonra yeniden etkinleştirmek için kaynak dosyanıza ön işlemci yönergeleri ekleyin.

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

Bir dosya, klasör veya projenin kuralını devre dışı bırakmak için, yapılandırma dosyasındaki önem derecesini noneolarak ayarlayın.

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

Daha fazla bilgi için bkz . Kod analizi uyarılarını gizleme.