CA1720: Los identificadores no deben contener nombres de tipo

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

Causa

El nombre de un parámetro en un miembro contiene un nombre de tipo de datos.

O bien

El nombre de un miembro contiene un nombre de tipo de datos específico del lenguaje.

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

Descripción de la regla

Los nombres de los parámetros y los miembros se utilizan mejor para comunicar su significado que para describir su tipo, que se espera que proporcionen las herramientas de desarrollo. En el caso de los nombres de los miembros, si se debe usar un nombre de tipo de datos, use un nombre independiente del lenguaje en lugar de uno específico del lenguaje. Por ejemplo, en lugar del nombre de tipo de C# int, use el nombre del tipo de datos independiente del lenguaje, Int32.

Los tokens discretos en el nombre del parámetro o el miembro se comprueban con los siguientes nombres de tipos de datos específicos del lenguaje sin distinguir entre mayúsculas y minúsculas:

  • Bool
  • WChar
  • Int8
  • UInt8
  • Short
  • UShort
  • Int
  • UInt
  • Entero
  • UInteger
  • long
  • ULong
  • Sin signo
  • Firmado
  • Float
  • Float32
  • Float64

Además, los nombres de un parámetro también se comprueban con los siguientes nombres de tipos de datos independientes del lenguaje, sin distinguir entre mayúsculas y minúsculas:

  • Object
  • Boolean
  • Char
  • String
  • SByte
  • Byte
  • UByte
  • Int16
  • UInt16
  • Int32
  • UInt32
  • Int64
  • UInt64
  • IntPtr
  • Ptr
  • Puntero
  • UInptr
  • UPtr
  • UPointer
  • Single
  • Double
  • Decimal
  • Guid

Cómo corregir infracciones

Si se desencadena en un parámetro:

Reemplace el identificador de tipo de datos en el nombre del parámetro por un término que describa mejor su significado o un término más genérico, como "valor".

Si se desencadena en un miembro:

Reemplace el identificador de tipo de datos específico del lenguaje en el nombre del miembro por un término que describa mejor su significado, un equivalente independiente del lenguaje o un término más genérico, como "valor".

Cuándo suprimir las advertencias

El uso ocasional de nombres de parámetros y miembros basados en tipos puede ser adecuado. Sin embargo, para el nuevo desarrollo, no hay escenarios conocidos donde se deba suprimir una advertencia de esta regla. En el caso de las bibliotecas enviadas anteriormente, es posible que tenga que suprimir una advertencia de esta regla.

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

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.CA1720.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 (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