Comparteix a través de

CA1822: Marcar miembros como estáticos

Propiedad Valor
Identificador de la regla CA1822
Título Marcar miembros como estáticos
Categoría Rendimiento
La corrección es de ruptura o no de ruptura Si el miembro no es visible fuera del ensamblaje, independientemente del cambio que realice, no provoca rupturas.

No interrumpe: Si simplemente cambia el miembro a un miembro de instancia usando la palabra clave this.

Problemática: Si cambia el miembro de un miembro de instancia a un miembro estático y es visible fuera del ensamblado.
Habilitado de forma predeterminada en .NET 10 Como sugerencia
Idiomas aplicables C# y Visual Basic

Causa

Un miembro que no accede a los datos de instancia no está marcado como estático (compartido en Visual Basic).

Descripción de la regla

Los miembros que no acceden a datos de instancia ni llaman a métodos de instancia se pueden marcar como estáticos (Shared en Visual Basic). Después de marcar los métodos como _static_, el compilador emitirá los sitios de llamada no virtuales para dichos miembros. La emisión de sitios de llamadas no virtuales impedirá una comprobación en tiempo de ejecución para cada llamada que asegúrese de que el puntero del objeto actual no sea NULL. Con ello se puede lograr una mejora apreciable del rendimiento del código en el que el rendimiento es fundamental. En algunos casos, el error de acceso a la instancia de objeto actual representa un problema de precisión.

Cómo corregir infracciones

Marque el miembro como estático (o como compartido en Visual Basic) o use "this"/"Me" en el cuerpo del método, si procede.

Example

public class Printer
{
    private readonly List<char> _items = [
        'H', 'e', 'l', 'l', 'o',
    ];

    public void PrintHello()
    {
        BadPrintHelloInternal();
        GoodPrintHelloInternal();
        GoodPrintHelloStaticInternal();
    }

    // This method violates the rule.
    private void BadPrintHelloInternal()
    {
        Console.WriteLine("Hello");
    }

    // This methods satisfies the rule.
    private void GoodPrintHelloInternal()
    {
        Console.WriteLine(string.Join(string.Empty, this._items));
    }

    private static void GoodPrintHelloStaticInternal()
    {
        Console.WriteLine("Hello");
    }
}

Cuándo suprimir las advertencias

Es seguro suprimir una advertencia de esta regla en los casos siguientes:

  • Para el código previamente lanzado para el que la corrección sería un cambio disruptivo.
  • Para los métodos de las clases que heredan de MarshalByRefObject. Los métodos de estas clases no deben marcarse como estáticos, ya que la infraestructura de comunicación remota de .NET usa el envío de instancias para reenviar llamadas a través de los límites de AppDomain. Hacer que estos métodos sean estáticos puede interrumpir la comunicación remota a través de los límites de AppDomain.

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

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.CA1822.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 la opción siguiente para configurar en qué partes del código base ejecutar esta regla.

Puede configurar esta opción solo para esta regla, para todas las reglas a las que se aplica o para todas las reglas de esta categoría (Rendimiento) a las que se aplica. 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 se ejecutará esta regla, en función de su accesibilidad, estableciendo la opción api_surface. 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

Nota:

Reemplace la parte XXXX de CAXXXX por el identificador de la regla que aplique.

  • Last updated on