CA1710: Los identificadores deben tener un sufijo correcto

  • Artículo
Propiedad Value
Identificador de la regla CA1710
Título Los identificadores deben tener un sufijo correcto
Categoría Nomenclatura
La corrección es problemática o no problemática Problemático
Habilitado de forma predeterminada en .NET 8 No

Causa

Un identificador no tiene el sufijo correcto.

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

Descripción de la regla

Por convención, los nombres de tipos que extienden determinados tipos base o que implementan algunas interfaces, o tipos derivados de estos tipos, tienen un sufijo asociado al tipo base o a la interfaz.

Las convenciones de nomenclatura proporcionan una apariencia común para las bibliotecas destinadas a Common Language Runtime. Esto reduce la curva de aprendizaje necesaria para las nuevas bibliotecas de software y aumenta la confianza del cliente respecto a que la biblioteca se haya desarrollado por parte de un especialista en desarrollo de código administrado.

En la tabla siguiente se enumeran los tipos base y las interfaces que tienen sufijos asociados.

Tipo base/Interfaz Sufijo
System.Attribute Atributo
System.EventArgs EventArgs
System.Exception Excepción
System.Collections.ICollection Colección
System.Collections.IDictionary Diccionario
System.Collections.IEnumerable Colección
System.Collections.Generic.IReadOnlyDictionary<TKey,TValue> Diccionario
System.Collections.Queue Collection o Queue
System.Collections.Stack Collection o Stack
System.Collections.Generic.ICollection<T> Colección
System.Collections.Generic.IDictionary<TKey,TValue> Diccionario
System.Data.DataSet DataSet
System.Data.DataTable Collection o DataTable
System.IO.Stream Stream
System.Security.IPermission Permiso
System.Security.Policy.IMembershipCondition Condición
Delegado del controlador de eventos. EventHandler

Los tipos que implementan ICollection y son un tipo generalizado de estructura de datos, como un diccionario, una pila o una cola, son nombres permitidos que proporcionan información significativa sobre el uso previsto del tipo.

Los tipos que implementan ICollection y son una colección de elementos específicos tienen nombres que terminan con la palabra "Collection". Por ejemplo, una colección de objetos Queue tendría el nombre "QueueCollection". El sufijo "Collection" indica que los miembros de la colección se pueden enumerar mediante la instrucción foreach (For Each en Visual Basic).

Los tipos que implementan IDictionary o IReadOnlyDictionary<TKey,TValue> tienen nombres que terminan con la palabra "Dictionary" incluso si el tipo también implementa IEnumerable o ICollection. Las convenciones de nomenclatura de los sufijos "Collection" y "Dictionary" permiten a los usuarios distinguir entre los dos patrones de enumeración siguientes.

Los tipos con el sufijo "Collection" siguen este patrón de enumeración.

foreach(SomeType x in SomeCollection) { }

Los tipos con el sufijo "Dictionary" siguen este patrón de enumeración.

foreach(SomeType x in SomeDictionary.Values) { }

Un objeto DataSet está formado por una colección de objetos DataTable, que a su vez están formados por colecciones de objetos System.Data.DataColumn y System.Data.DataRow, entre otros. Estas colecciones implementan ICollection mediante la clase base System.Data.InternalDataCollectionBase.

Cómo corregir infracciones

Cambie el nombre del tipo para que tenga como sufijo el término correcto.

Cuándo suprimir las advertencias

Es seguro suprimir una advertencia para usar el sufijo "Collection" si el tipo es una estructura de datos generalizada que podría extenderse o que contendrá un conjunto arbitrario de diversos elementos. En este caso, un nombre que proporcione información significativa sobre la implementación, el rendimiento u otras características de la estructura de datos podría tener sentido (por ejemplo, BinaryTree). En los casos en los que el tipo representa una colección de un tipo específico (por ejemplo, StringCollection), no suprima advertencias de esta regla, puesto que el sufijo indica que el tipo se puede enumerar mediante una instrucción foreach.

En el caso de otros sufijos, no suprima advertencias de esta regla. El sufijo permite que el uso previsto sea evidente por el nombre del 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 CA1710
// The code that's violating the rule is on this line.
#pragma warning restore CA1710

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.CA1710.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 aplica o para todas las reglas de esta categoría (Nomenclatura) 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

Exclusión de tipos base indirectos

Puede configurar si se deben excluir de la regla los tipos base indirectos. De forma predeterminada, esta opción se establece en true, lo que restringe el análisis del tipo base actual.

dotnet_code_quality.CA1710.exclude_indirect_base_types = false

Sufijos adicionales necesarios

Puede proporcionar sufijos adicionales necesarios o invalidar el comportamiento de algunos sufijos codificados. Para ello, agregue el siguiente par clave-valor a un archivo .editorconfig en el proyecto:

dotnet_code_quality.CA1710.additional_required_suffixes = [type]->[suffix]

Separe los distintos valores con el carácter |. Los tipos se pueden especificar en cualquiera de los siguientes formatos:

  • Solo nombre de tipo (incluye todos los tipos con el nombre, independientemente del tipo contenedor o el espacio de nombres).
  • Nombres completos en el formato de identificador de documentación del símbolo, con un prefijo T: opcional.

Ejemplos:

Valor de la opción Resumen
dotnet_code_quality.CA1710.additional_required_suffixes = MyClass->Class Todos los tipos que se heredan de "MyClass" deben tener el sufijo "Class".
dotnet_code_quality.CA1710.additional_required_suffixes = MyClass->Class|MyNamespace.IPath->Path Todos los tipos que se heredan de "MyClass" deben tener el sufijo "Class", y todos los tipos que implementen "MyNamespace.IPath" deben tener el sufijo "Path".
dotnet_code_quality.CA1710.additional_required_suffixes = T:System.Data.IDataReader->{} Invalida los sufijos integrados. En este caso, ya no es necesario que todos los tipos que implementan "IDataReader" terminen en "Collection".

CA1711: Los identificadores no deben tener un sufijo incorrecto

Vea también