Los identificadores no deben contener nombres de tipos
Actualización: noviembre 2007
Nombre de tipo |
IdentifiersShouldNotContainTypeNames |
Identificador de comprobación |
CA1720 |
Categoría |
Microsoft.Naming |
Cambio problemático |
Sí |
Motivo
El nombre de un parámetro de un miembro visible externamente contiene un nombre de tipo de dato.
O bien,
El nombre de un miembro visible externamente contiene un nombre de tipo de dato específico del lenguaje.
Descripción de la regla
Es mejor utilizar los nombres de parámetros y miembros para transmitir su significado que para describir el tipo al que pertenecen, ya que esta información suelen proporcionarla las herramientas de desarrollo. En los nombres de miembros, si es necesario utilizar un nombre de tipo de datos, utilice un nombre independiente del lenguaje en lugar de uno específico del lenguaje. Por ejemplo, en lugar de utilizar el nombre de tipo de C# 'int', utilice el nombre de tipo de datos independiente del lenguaje Int32.
Cada token que conforma el nombre del miembro o parámetro se compara con los siguientes nombres de tipos de datos específicos del lenguaje sin hacer distinción entre mayúsculas y minúsculas:
Bool
WChar
Int8
UInt8
Short
UShort
Int
UInt
Integer
UInteger
Long
ULong
Unsigned
Signed
Float
Float32
Float64
Además de con los nombres anteriores, los nombres de parámetro también se comparan con los siguientes nombres de tipos de datos independientes del lenguaje sin hacer distinción entre mayúsculas y minúsculas:
Object
Obj
Boolean
Char
String
SByte
Byte
UByte
Int16
UInt16
Int32
UInt32
Int64
UInt64
IntPtr
Ptr
Pointer
UInptr
UPtr
UPointer
Single
Double
Decimal
Guid
Cómo corregir infracciones
Si se produce en un parámetro:
Sustituya el identificador del tipo de dato del nombre del parámetro por un término que describa mejor su significado o por un término más genérico, como 'valor.'
Si se produce en un miembro:
Sustituya el identificador de tipo de dato específico del lenguaje del nombre del miembro por un término que describa mejor su significado, un término equivalente independiente del lenguaje o un término más genérico, como 'valor.'
Cuándo suprimir advertencias
Es posible que en ocasiones sea conveniente utilizar nombres de parámetros y miembros basados en tipos. Sin embargo, en un nuevo desarrollo, no hay ningún escenario conocido donde sea necesario suprimir una advertencia de esta regla. Es posible que deba suprimir una advertencia de esta regla en las bibliotecas distribuidas anteriormente.
Reglas relacionadas
Los identificadores deberían utilizar las mayúsculas y minúsculas correctamente
Los identificadores se deberían diferenciar en algo más que en el uso de mayúsculas y minúsculas
Los identificadores no deberían contener subrayado
Los nombres de parámetro no deberían coincidir con los nombres de miembro