Compartir a través de

CA1711: Los identificadores no deben tener un sufijo incorrecto

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

Causa

Un identificador tiene un sufijo incorrecto.

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, deben terminar con unos sufijos reservados específicos. Otros nombres de tipo no deben utilizar estos sufijos reservados.

En la tabla siguiente se muestran los sufijos reservados y los tipos base e interfaces a los que se asocian.

Sufijo Tipo base/Interfaz
Attribute System.Attribute
Collection System.Collections.ICollection

System.Collections.IEnumerable

System.Collections.Queue

System.Collections.Stack

System.Collections.Generic.ICollection<T>

System.Data.DataSet

System.Data.DataTable
Dictionary System.Collections.IDictionary

System.Collections.Generic.IDictionary<TKey,TValue>
EventArgs System.EventArgs
EventHandler Delegado del controlador de eventos.
Exception System.Exception
Permission System.Security.IPermission
Queue System.Collections.Queue
Stack System.Collections.Stack
Stream System.IO.Stream

Además, no se deben usar los sufijos siguientes:

  • Delegate
  • Enum
  • Ex o un sufijo similar para distinguir de una versión anterior del mismo tipo
  • Flag o Flags para los tipos de enumeración
  • Impl (use Core en su lugar)
  • New si ya existe un miembro con el mismo nombre, pero sin el sufijo New

Las convenciones de nomenclatura proporcionan una búsqueda común de bibliotecas destinadas a Common Language Runtime de .NET. Estas convenciones reducen la curva de aprendizaje necesaria para las nuevas bibliotecas de software y aumentan la confianza del cliente de que la biblioteca la desarrolló alguien con experiencia en el desarrollo de código administrado. Para obtener más información, consulte Instrucciones de nomenclatura: clases, structs e interfaces.

Cómo corregir infracciones

Quite el sufijo del nombre de tipo.

Cuándo suprimir las advertencias

No suprima una advertencia de esta regla a menos que el sufijo no tenga un significado ambiguo en el dominio de aplicación.

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

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.CA1711.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 tan solo para esta regla, para todas las reglas a las que sean aplicables o para todas las reglas de esta categoría (Nomenclatura) para las que sean aplicables. Para más información, vea Opciones de configuración de reglas de calidad de código.

Incluir superficies específicas del API

Puede configurar en qué partes del código base se ejecutará esta regla, en función de su accesibilidad, mediante la configuración de 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 sea de aplicación.

Permitir sufijos

Puede configurar una lista de sufijos permitidos, con cada sufijo separado por el carácter de barra vertical ("|"). Por ejemplo, para especificar que la regla no se debe ejecutar en los sufijos Flag o Flags, agregue el siguiente par clave-valor a un archivo .editorconfig en el proyecto:

dotnet_code_quality.ca1711.allowed_suffixes = Flag|Flags

Vea también