CA1709: Los identificadores deben utilizar las mayúsculas y minúsculas correctamente

  • Artículo
Elemento Valor
RuleId CA1709
Category Microsoft.Naming
Cambio importante Problemático: cuando se genera en ensamblados, espacios de nombres, tipos, miembros y parámetros.

No problemático: cuando se produce en parámetros de tipo genérico.

Causa

El nombre de un identificador no usa las mayúsculas correctamente.

O bien

El nombre de un identificador contiene un acrónimo de dos letras y la segunda letra está en minúsculas.

O bien

El nombre de un identificador contiene un acrónimo de tres o más letras mayúsculas.

Descripción de la regla

Las convenciones de nomenclatura proporcionan una apariencia común para las bibliotecas destinadas a Common Language Runtime. Esta coherencia 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.

Por convención, los nombres de parámetro utilizan la convención Camel de uso de mayúsculas, mientras que los nombres de espacio de nombres, tipo y miembro utilizan la convención Pascal. En un nombre con convención de mayúsculas Camel, la primera letra es minúscula y la primera letra de las palabras restantes del nombre está en mayúsculas. Algunos ejemplos de nombres con convención de mayúsculas Camel son packetSniffer, ioFile y fatalErrorCode. En un nombre con convención de mayúsculas Pascal, la primera letra es mayúscula y la primera letra de las palabras restantes del nombre está en mayúsculas. Algunos ejemplos de nombres con convención de mayúsculas Pascal son PacketSniffer, IOFile y FatalErrorCode.

Esta regla divide el nombre en palabras basadas en el uso de mayúsculas y minúsculas y comprueba las palabras de dos letras en una lista de palabras comunes de dos letras, como "In" o "My". Si no se encuentra una coincidencia, se supone que la palabra es un acrónimo. Además, esta regla supone que ha encontrado un acrónimo cuando el nombre contiene cuatro letras mayúsculas seguidas o tres letras mayúsculas seguidas al final del nombre.

Por convención, los acrónimos de dos letras se escriben con todas las letras mayúsculas y los acrónimos de tres o más caracteres usan la convención de mayúsculas Pascal. En los ejemplos siguientes se usa esta convención de nomenclatura: "DB", "CR", "Cpa" y "Ecma". En los ejemplos siguientes se infringe la convención: "Io", "XML" y "DoD", y para nombres que no son parámetros, "xp" y "cpl".

"ID" tiene un uso de mayúsculas especial para provocar una infracción de esta regla. "Id" no es un acrónimo, sino una abreviatura de "identificación".

Cómo corregir infracciones

Cambie el nombre para que use las mayúsculas y minúsculas correctamente.

Cuándo suprimir las advertencias

Es seguro suprimir esta advertencia si tiene sus propias convenciones de nomenclatura o si el identificador representa un nombre adecuado, por ejemplo, el nombre de una empresa o una tecnología.

También puede agregar términos, abreviaturas y acrónimos específicos a un diccionario personalizado de análisis de código. Los términos especificados en el diccionario personalizado no provocarán infracciones de esta regla. Para obtener más información, consulte Cómo: Personalización del diccionario de análisis de código.

CA1708: Los identificadores se deben diferenciar en algo más que en el uso de mayúsculas y minúsculas