CA1802: Utilizar literales cuando sea apropiado

  • Artículo
Propiedad Value
Identificador de la regla CA1802
Título Utilizar literales cuando sea apropiado
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

Un campo se declara como static y readonly (Shared y ReadOnly en Visual Basic) y se inicializa con un valor que se puede calcular en tiempo de compilación.

De forma predeterminada, esta regla solo examina los campos visibles externamente, estáticos y de solo lectura, pero es configurable.

Descripción de la regla

El valor de un campo static readonly se calcula en tiempo de ejecución cuando se llama al constructor estático del tipo declarativo. Si el campo static readonly se inicializa cuando se declara y no se declara explícitamente un constructor estático, el compilador emite un constructor estático para inicializar el campo.

El valor de un campo const se calcula en tiempo de compilación y se almacena en los metadatos, lo que aumenta el rendimiento en tiempo de ejecución cuando se compara con un campo static readonly.

Dado que el valor asignado al campo de destino se calcula en tiempo de compilación, cambie la declaración a un campo const para que el valor se calcule en tiempo de compilación en lugar de en tiempo de ejecución.

Cómo corregir infracciones

Para corregir una infracción de esta regla, sustituya los modificadores static y readonly por el modificador const.

Nota

El uso del modificador const no se recomienda para todos los escenarios.

Cuándo suprimir las advertencias

Es seguro suprimir una advertencia de esta regla o deshabilitar la regla si no le preocupa el rendimiento.

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 CA1802
// The code that's violating the rule is on this line.
#pragma warning restore CA1802

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.CA1802.severity = none

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

Configuración del código para analizar

Use las opciones siguientes para configurar en qué partes del código base se va a ejecutar esta regla.

Puede configurar estas opciones solo para esta regla, para todas las reglas a las que se aplican o para todas las reglas de esta categoría (Rendimiento) a las que se aplican. Para más información, vea Opciones de configuración de reglas de calidad de código.

Incluir superficies de API específicas

Puede configurar en qué partes del código base ejecutar esta regla, en función de su accesibilidad. Por ejemplo, para especificar que la regla solo se debe ejecutar en la superficie de API no públicas, agregue el siguiente par clave-valor a un archivo .editorconfig en el proyecto:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Modificadores obligatorios

Puede configurar esta regla para invalidar los modificadores de campo obligatorios. De forma predeterminada, static y readonly son modificadores obligatorios para los campos que se analizan. Puede invalidar este valor en una lista separada por comas de uno o más valores de modificador de la tabla siguiente:

Valor de la opción Resumen
none Ningún requisito de modificador.
static o Shared Se debe declarar como "static" ("Shared" en Visual Basic).
const Se debe declarar como "const".
readonly Se debe declarar como "readonly".

Por ejemplo, para especificar que la regla no se debe ejecutar en los campos static e instance, agregue el siguiente par clave-valor a un archivo .editorconfig en el proyecto:

dotnet_code_quality.CA1802.required_modifiers = none

Ejemplo

En el ejemplo siguiente se muestra un tipo que infringe esta regla (UseReadOnly) y uno que la cumple (UseConstant).

Imports System

Namespace ca1802

    ' This class violates the rule.
    Public Class UseReadOnly

        Shared ReadOnly x As Integer = 3
        Shared ReadOnly y As Double = x + 2.1
        Shared ReadOnly s As String = "readonly"

    End Class

    ' This class satisfies the rule.
    Public Class UseConstant

        Const x As Integer = 3
        Const y As Double = x + 2.1
        Const s As String = "const"

    End Class

End Namespace

// This class violates the rule.
public class UseReadOnly
{
    static readonly int x = 3;
    static readonly double y = x + 2.1;
    static readonly string s = "readonly";

    public void Print()
    {
        Console.WriteLine(s);
    }
}

// This class satisfies the rule.
public class UseConstant
{
    const int x = 3;
    const double y = x + 2.1;
    const string s = "const";
}