Convenciones generales de nomenclatura

Las convenciones generales de nomenclatura explican la elección de los nombres más adecuados para los elementos de sus bibliotecas. Estas instrucciones se aplican a todos los identificadores. Las secciones posteriores tratan la nomenclatura de elementos concretos, como espacios de nombres o propiedades.

Elección de palabra

Elija los nombres fácilmente legibles para los identificadores. Por ejemplo, una propiedad denominada HorizontalAlignment es más legible en inglés que AlignmentHorizontal.

Es preferible la legibilidad a la brevedad. El nombre de propiedad CanScrollHorizontally es mejor que ScrollableX (una referencia oculta al eje X).

No utilice guiones de subrayado, guiones ni ningún otro carácter no alfanumérico.

No utilice la notación húngara.

La notación húngara consiste en incluir un prefijo en los identificadores para codificar ciertos metadatos sobre el parámetro, como puede ser el tipo de datos del identificador.

Evite utilizar identificadores que están en conflicto con palabras clave de lenguajes de programación ampliamente utilizados.

Aunque los lenguajes conformes a CLS deben proporcionar una manera de utilizar palabras clave como palabras normales, los procedimientos recomendados indican que no debería obligar a los desarrolladores a saber cómo hacerlo. Para la mayoría de los lenguajes de programación, la documentación de la referencia del lenguaje contiene una lista de las palabras clave utilizada por los lenguajes. La tabla siguiente proporciona vínculos a la documentación de referencia de algunos lenguajes de programación ampliamente utilizados.

Abreviaturas y acrónimos

En general, no debería utilizar abreviaturas ni acrónimos. Estos elementos hacen que los nombres sean menos legibles. De igual forma, es difícil saber cuándo es seguro suponer que un acrónimo es ampliamente reconocido.

Para conocer las reglas de uso de mayúsculas para las abreviaturas, vea Normas referentes al uso de minúsculas y mayúsculas.

No utilice abreviaturas ni contracciones como parte de nombres de identificadores.

Por ejemplo, use OnButtonClick en lugar de OnBtnClick.

No utilice cualquier ningún acrónimo que no esté ampliamente aceptado y, además, sólo cuando necesario.

Nombres específicos de lenguajes

Para los nombres de tipos, utilice nombres con interés semántico en lugar de palabras clave específicas de lenguaje. Por ejemplo, GetLength es mejor nombre que GetInt.

Utilice nombres de tipos de Common Language Runtime (CLR) en lugar de nombres específicos de lenguaje, en los pocos casos en los que un identificador no tiene ningún significado semántico más allá de su tipo.

Por ejemplo, un método que convierte los datos en Int16 se debería denominar ToInt16, no ToShort porque Short es el nombre de tipo específico de lenguaje para Int16.

La tabla siguiente muestra los nombres de tipo específicos de lenguaje para los lenguajes de programación más comunes y sus homólogos de CLR.

Utilice un nombre común, como un valor o elemento, en lugar de repetir el nombre de tipo en los raros casos en los que un identificador no tenga significado semántico y el tipo del parámetro no sea importante.

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 “las instrucciones de diseño de Framework: Convenciones, frases realizadas y modelos para libro de bibliotecas reutilizables de .NET” de Krzysztof Cwalina y Brad Abrams, publicados por Addison-Wesley, 2005.

Vea también

Otros recursos

Instrucciones de diseño para desarrollar bibliotecas de clases

Instrucciones de nomenclatura