CA1058: Los tipos no deben ampliar ciertos tipos base
| Propiedad | Value |
|---|---|
| Identificador de la regla | CA1058 |
| Título | Los tipos no deben ampliar ciertos tipos base |
| Categoría | Diseño |
| La corrección es problemática o no problemática | Problemático |
| Habilitado de forma predeterminada en .NET 9 | No |
Causa
Un tipo extiende uno de los siguientes tipos base:
- System.ApplicationException
- System.Xml.XmlDocument
- System.Collections.CollectionBase
- System.Collections.DictionaryBase
- System.Collections.Queue
- System.Collections.ReadOnlyCollectionBase
- System.Collections.SortedList
- System.Collections.Stack
De forma predeterminada, esta regla solo examina los tipos visibles externamente, pero es configurable.
Descripción de la regla
Las excepciones deben derivar de System.Exception o de una de sus subclases en el espacio de nombres System.
No cree una subclase de XmlDocument si quiere crear una vista XML de un origen de datos o un modelo de objetos subyacente.
Colecciones no genéricas
Use o extienda colecciones genéricas siempre que sea posible. No extienda colecciones no genéricas en el código, a menos que ya lo haya enviado.
Ejemplos de uso incorrecto
public class MyCollection : CollectionBase
{
}
public class MyReadOnlyCollection : ReadOnlyCollectionBase
{
}
Ejemplos de uso correcto
public class MyCollection : Collection<T>
{
}
public class MyReadOnlyCollection : ReadOnlyCollection<T>
{
}
Cómo corregir infracciones
Para corregir una infracción de esta regla, derive el tipo de un tipo base diferente o de una colección genérica.
Cuándo suprimir las advertencias
No suprima una advertencia de esta regla para las infracciones sobre ApplicationException. Es seguro suprimir una advertencia de esta regla para las infracciones sobre XmlDocument. Es seguro suprimir una advertencia sobre una colección no genérica si el código ya se ha lanzado.
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 CA1058
// The code that's violating the rule is on this line.
#pragma warning restore CA1058
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.CA1058.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
