CA1052: Los tipos contenedores estáticos deben ser Static o NotInheritable

  • Artículo
Propiedad Value
Identificador de la regla CA1052
Título Los tipos de soporte estático deben ser estáticos o no heredables
Categoría Diseño
La corrección es problemática o no problemática Problemático
Habilitado de forma predeterminada en .NET 8 No

Causa

Un tipo no abstracto solo contiene miembros estáticos (distintos de un posible constructor predeterminado) y no se ha declarado con el modificador static o Shared.

De forma predeterminada, esta regla solo examina los tipos visibles externamente, pero es configurable.

Descripción de la regla

La regla CA1052 da por supuesto que un tipo que solo contiene miembros estáticos no está diseñado para heredarse, ya que el tipo no proporciona ninguna funcionalidad que se pueda invalidar en un tipo derivado. Un tipo que no está diseñado para heredarse debería marcarse con el modificador static en C# para impedir su uso como tipo base. Además, debe quitarse su constructor predeterminado. En Visual Basic, la clase debe convertirse en un módulo.

Esta regla no se activa para clases abstractas o clases que tienen una clase base. Aun así, la regla se activa para las clases que admiten una interfaz vacía.

Nota

En la implementación de analizador más reciente de esta regla, también engloba la funcionalidad de la regla CA1053.

Cómo corregir infracciones

Para corregir una infracción de esta regla, marque el tipo como static y quite el constructor predeterminado (C#) o conviértalo en un módulo (Visual Basic).

Cuándo suprimir las advertencias

Puede suprimir las infracciones en los casos siguientes:

  • El tipo está diseñado para heredarse. La ausencia del modificador static sugiere que el tipo es útil como tipo base.
  • El tipo se usa como argumento de tipo. Los tipos estáticos no se pueden usar como argumentos de tipo.

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

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.CA1052.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 (Diseño) 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 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

Ejemplo de infracción

En el ejemplo siguiente se muestra un tipo que infringe la regla:

public class StaticMembers
{
    public static int SomeProperty { get; set; }
    public static void SomeMethod() { }
}

Imports System

Namespace ca1052

    Public Class StaticMembers

        Shared Property SomeProperty As Integer

        Private Sub New()
        End Sub

        Shared Sub SomeMethod()
        End Sub

    End Class

End Namespace

Corrección con el modificador static

En el ejemplo siguiente se muestra cómo se corrige una infracción de esta regla marcando el tipo con el modificador static en C#:

public static class StaticMembers
{
    public static int SomeProperty { get; set; }
    public static void SomeMethod() { }
}