Normas referentes al uso de minúsculas y mayúsculas
Actualización: noviembre 2007
Muchas de las convenciones de nomenclatura pertenecen al uso de mayúsculas y minúsculas en los identificadores. Es importante tener en cuenta que Common Language Runtime (CLR) admite los lenguajes con distinción entre mayúsculas y minúsculas y sin distinción de ellas. Las convenciones del uso de mayúsculas y minúsculas explicadas en este tema facilitan a los desarrolladores la comprensión y el trabajo de la biblioteca.
Estilos de grafía
Las condiciones siguientes describen distintas maneras de usar mayúsculas y minúsculas de los identificadores.
Grafía Pascal
La primera letra del identificador y la primera letra de las siguientes palabras concatenadas están en mayúsculas. El estilo de mayúsculas y minúsculas Pascal se puede utilizar en identificadores de tres o más caracteres. Por ejemplo:
BackColor
Grafía Camel
La primera letra del identificador está en minúscula y la primera letra de las siguientes palabras concatenadas en mayúscula. Por ejemplo:
backColor
Mayúsculas
Todas las letras del identificador van en mayúsculas. Por ejemplo:
IO
Reglas de uso de mayúsculas y minúsculas para los identificadores
Cuando un identificador está compuesto de varias palabras, no utilice separadores, como guiones de subrayado ("_") ni guiones ("-"), entre las palabras. En su lugar, utilice la grafía para señalar el principio de cada palabra.
Las instrucciones siguientes proporcionan reglas generales para los identificadores.
Utilice la grafía Pascal para todos los nombres de miembros públicos, tipos y espacios de nombres que constan de varias palabras.
Tenga en cuenta que esta regla no se aplica a las instancias de campos. Por los motivos que se detallan en Instrucciones de diseño de miembros, no debería utilizar campos de instancia públicos.
Utilice el uso combinado de mayúsculas y minúsculas tipo Camel para los nombres de parámetros.
En la tabla siguiente se resumen las reglas de uso de mayúsculas y minúsculas para los identificadores y se proporcionan ejemplos de los diferentes tipos de identificadores.
Identificador |
Uso de mayúsculas o minúsculas |
Ejemplo |
---|---|---|
Clase |
Pascal |
AppDomain |
Tipo de enumeración |
Pascal |
ErrorLevel |
Valores de enumeración |
Pascal |
FatalError |
Evento |
Pascal |
ValueChanged |
Clase de excepción |
Pascal |
WebException |
Campo estático de sólo lectura |
Pascal |
RedValue |
Interfaz |
Pascal |
IDisposable |
Método |
Pascal |
ToString |
Espacio de nombres |
Pascal |
System.Drawing |
Parámetro |
Camel |
typeName |
Propiedad |
Pascal |
BackColor |
Reglas de uso de mayúsculas para los acrónimos
Un acrónimo es una palabra formada a partir de las letras de las palabras de un término o frase. Por ejemplo, HTML es un acrónimo de Hypertext Markup Language (lenguaje de marcado de hipertexto). Sólo debería incluir acrónimos en identificadores cuando son muy conocidos y están bien entendidos. Los acrónimos se diferencian de las abreviaturas en que una abreviatura acorta una sola palabra. Por ejemplo, ID es una abreviatura de identifier. En general, los nombres de biblioteca no deberían utilizar las abreviaturas.
Nota
Las dos abreviaturas que se pueden utilizar en los identificadores son ID y OK. En identificadores con grafía Pascal, deberían aparecer como Id y Ok. Si se utilizan como la primera palabra de un identificador con grafía tipo Camel, deberían aparecer como id y ok, respectivamente.
La grafía de los acrónimos depende de la longitud del acrónimo. Todos los acrónimos tienen al menos dos caracteres de longitud. A efectos de estas instrucciones, si un acrónimo tiene exactamente dos caracteres, se considera como acrónimo corto. Un acrónimo de tres o más caracteres es un acrónimo largo.
Las instrucciones siguientes especifican la grafía apropiada para los acrónimos cortos y los largos. Las reglas de grafía de identificadores tienen prioridad sobre las reglas de grafía de acrónimos.
Ponga en mayúsculas ambos caracteres de los acrónimos de dos caracteres, excepto cuando se trata de la primera palabra de un identificador con grafía tipo Camel.
Una propiedad denominada DBRate es un ejemplo de un acrónimo corto (DB) utilizado como la primera palabra de un identificador con grafía Pascal. Un parámetro denominado ioChannel es un ejemplo de un acrónimo corto (IO) utilizado como la primera palabra de un identificador con grafía Camel.
Ponga en mayúsculas sólo el primer carácter de los acrónimos con tres o más caracteres, excepto si es la primera palabra de un identificador con grafía Camel.
Una clase denominada XmlWriter es un ejemplo de un acrónimo largo utilizado como la primera palabra de un identificador con grafía Camel. Un parámetro denominado htmlReader es un ejemplo de un acrónimo largo utilizado como la primera palabra de un identificador con grafía Camel.
No ponga en mayúsculas ninguno de los caracteres de los acrónimos, independientemente de su longitud, al principio de un identificador con grafía Camel.
Un parámetro denominado xmlStream es un ejemplo de un acrónimo largo (xml) utilizado como la primera palabra de un identificador con grafía Camel. Un parámetro denominado dbServerName es un ejemplo de un acrónimo corto (db) utilizado como la primera palabra de un identificador con grafía Camel.
Reglas de uso de mayúsculas para palabras compuestas y términos comunes
No ponga en mayúsculas todas las palabras en las denominadas palabras compuestas con formato cerrado. Éstas son palabras compuestas escritas como una sola palabra, como por ejemplo "endpoint".
Por ejemplo, hashtable es una palabra compuesta con formato cerrado que se debería tratar como una sola palabra y se debería utilizar la grafía correspondiente. En la grafía Pascal, es Hashtable; mientras que en la grafía Camel, es hashtable. Para determinar si una palabra es una palabra compuesta con formato cerrado, compruebe un diccionario actualizado.
La lista siguiente identifica algunos términos comunes que no son palabras compuestas con formato cerrado. La palabra se muestra en la grafía Pascal seguida por el formato de grafía Camel entre paréntesis.
BitFlag (bitFlag)
FileName (fileName)
LogOff (logOff)
LogOn (logOn)
SignIn (signIn)
SignOut (signOut)
UserName (userName)
WhiteSpace (whiteSpace)
Distinguir mayúsculas de minúsculas
Las instrucciones del uso de mayúsculas solamente se utilizan para facilitar la lectura y el reconocimiento de los identificadores. La grafía no se puede utilizar como medio para evitar que se produzcan colisiones entre los elementos de biblioteca.
No dé por supuesto que todos los lenguajes de programación distinguen entre mayúsculas y minúsculas. No es así. Los nombres no se pueden diferenciar exclusivamente por su grafía.
Portions Copyright 2005 Microsoft Corporation. Reservados todos los derechos.
Portions Copyright Addison-Wesley Corporation. Reservados todos los derechos.
Para obtener más información sobre las directrices de diseño, consulte el libro titulado "Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries" de Krzysztof Cwalina y Brad Abrams, publicado por Addison-Wesley, 2005.
Vea también
Otros recursos
Instrucciones de diseño para desarrollar bibliotecas de clases