CA1812: Evitar las clases internas sin instancia

  • Artículo
Propiedad Value
Identificador de la regla CA1812
Título Evitar las clases internas sin instancia
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

Nunca se crea una instancia de un tipo interno (nivel de ensamblado).

Descripción de la regla

Esta regla intenta localizar una llamada a uno de los constructores del tipo y notifica una infracción si no se encuentra ninguna llamada.

Esta regla no examina los tipos siguientes:

  • Tipos de valor
  • Tipos abstractos
  • Enumeraciones
  • Delegados
  • Tipos de matriz emitidos por el compilador
  • Tipos de los que no se pueden crear instancias y que solo definen métodos static.

Si aplica System.Runtime.CompilerServices.InternalsVisibleToAttribute al ensamblado que se está analizando, esta regla no marca los tipos marcados como internal (Friend en Visual Basic) de forma predeterminada porque un campo puede ser utilizado por un ensamblado de confianza. Para analizar el ensamblado de todos modos, consulte Configuración del código para analizar.

Cómo corregir infracciones

Para corregir una infracción de esta regla, quite el tipo o agregue el código que lo utiliza. Si el tipo solo contiene métodos static, agregue el modificador static al tipo para evitar que el compilador emita un constructor de instancia público predeterminado.

Cuándo suprimir las advertencias

Se puede suprimir una advertencia de esta regla. Se recomienda suprimir esta advertencia en las situaciones siguientes:

  • La clase se crea mediante métodos de reflexión enlazados posteriormente como System.Activator.CreateInstance.

  • La clase se registra en un contenedor de inversión de control (IoC) como parte del patrón de inyección de dependencias.

  • El entorno de ejecución o ASP.NET crean automáticamente la clase. Algunos ejemplos de clases creadas automáticamente son aquellos que implementan System.Configuration.IConfigurationSectionHandler o System.Web.IHttpHandler.

  • La clase se usa como parámetro de tipo en una definición de clase y tiene una new restricción. La regla CA1812 marcará el ejemplo siguiente:

    internal class MyClass
{
    public void DoSomething()
    {
    }
}
public class MyGeneric<T> where T : new()
{
    public T Create()
    {
        return new T();
    }
}

MyGeneric<MyClass> mc = new MyGeneric<MyClass>();
mc.Create();

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

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.CA1812.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.

Omisión del atributo InternalsVisibleTo

De forma predeterminada, esta regla está deshabilitada si el ensamblado que se analiza usa InternalsVisibleToAttribute para exponer sus símbolos internos. Para especificar que la regla se debe ejecutar incluso si el ensamblado está marcado con InternalsVisibleToAttribute, agregue el siguiente par clave-valor a un archivo .editorconfig en el proyecto:

dotnet_code_quality.CAXXXX.ignore_internalsvisibleto = true

Esta opción está disponible a partir de .NET 8.