CA1863: Uso de "CompositeFormat"

Propiedad	Value
Identificador de la regla	CA1863
Título	Use CompositeFormat
Categoría	Rendimiento
La corrección es problemática o no problemática	Poco problemático
Habilitado de forma predeterminada en .NET 8	No

Causa

El código llama a String.Format(String, Object[]) o StringBuilder.AppendFormat(String, Object[]) con una cadena de formato static que no se ha almacenado en caché en una instancia de CompositeFormat.

Descripción de la regla

Es caro analizar una cadena de formato en tiempo de ejecución. Esta regla busca lugares en el código donde puede almacenar en caché y usar una instancia de CompositeFormat como argumento para una operación de formato, en lugar de pasar la cadena de formato original. Una instancia de CompositeFormat analiza la cadena de formato compuesto cuando se crea, lo que significa que la "ruta de acceso activa" del formato de cadena puede ejecutarse mucho más rápido.

Cómo corregir infracciones

Cree una instancia de CompositeFormat llamando a CompositeFormat.Parse(String) y pásela a String.Format(IFormatProvider, CompositeFormat, Object[]) o a StringBuilder.AppendFormat(IFormatProvider, CompositeFormat, Object[]) en lugar de a la cadena de formato original.

Ejemplo

En el ejemplo siguiente se muestran dos infracciones de la regla:

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);
    }
}

En el ejemplo siguiente se muestra el código que corrige ambas infracciones:

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);
    }
}

Cuándo suprimir las advertencias

Es seguro suprimir diagnósticos de esta regla si el rendimiento no es un problema.

Supresión de una advertencia

Si solo quiere suprimir una única infracción, agregue directivas de preprocesador al archivo de origen para deshabilitar y volver a habilitar la regla.

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

Para deshabilitar la regla de un archivo, una carpeta o un proyecto, establezca su gravedad en none del archivo de configuración.

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

Para obtener más información, consulte Procedimiento para suprimir advertencias de análisis de código.