Nombres de miembros de tipos

Los tipos contienen los tipos siguientes de miembros:

• Métodos

• Propiedades

• Campos

• Eventos

Las instrucciones de esta sección ayudan a los diseñadores de bibliotecas de clases a seleccionar nombres para los miembros que sean coherentes con .NET Framework.

Nombres de métodos

Proporcione nombres de métodos que sean verbos o sintagmas verbales.

Normalmente los métodos actúan en datos, por lo que usar un verbo para describir la acción del método facilita a los desarrolladores la comprensión de lo que hace el método. Al definir la acción realizada por el método, tenga cuidado de seleccionar un nombre que proporciona claridad desde el punto de vista del desarrollador. No seleccione un verbo que describa cómo hace el método lo que hace; en otras palabras, no utilice detalles de implementación para el nombre del método.

Nombres de propiedades

Asigne nombres a las propiedades mediante un sustantivo, un sintagma nominal o un adjetivo.

Los sintagmas nominales o los adjetivos son adecuados para las propiedades porque éstas contienen datos.

No utilice propiedades que tengan los mismos nombres que los métodos Get.

Por ejemplo, no utilice un nombre de propiedad EmployeeRecord y denomine también un método GetEmployeeRecord. Los desarrolladores no sabrán qué miembro utilizar para conseguir su tarea de programación.

Denomine las propiedades booleanas con una frase afirmativa (CanSeek en lugar de CantSeek). Opcionalmente, también puede prefijar las propiedades booleanas con Is, Can o Has, pero sólo donde el prefijo aporte valor.

Considere la posibilidad de dar a una propiedad el mismo nombre que a su tipo.

Cuando se tiene una propiedad con establecimiento inflexible de tipos como enumeración, el nombre de la propiedad puede ser igual que el nombre de la enumeración. Por ejemplo, si tiene una enumeración denominada CacheLevel, una propiedad que devuelve uno de sus valores también se puede denominar CacheLevel.

Nombres de eventos

Denomine los eventos con un verbo o un sintagma verbal.

Asigne nombres de eventos a un concepto de antes y después, usando el tiempo presente y pasado. Por ejemplo, un evento de cierre que se inicie antes de que se cierre una ventana se podría llamar Closing y otro, llamado Closed, que se iniciara después de cerrarse la ventana.

No utilice los prefijos o sufijos Before (antes) o After (después) para señalar eventos anteriores y posteriores.

Denomine los controladores de eventos (los delegados utilizados como tipos de eventos) con el sufijo EventHandler.

Utilice dos parámetros denominados sender (remitente) y e en las firmas del controlador de eventos.

El parámetro sender debería ser del tipo Object y el parámetro e una instancia de EventArgs o heredar de ella.

Denomine las clases de argumento de evento con el sufijo EventArgs.

Nombres de campos

Las instrucciones de nomenclatura de campos se aplican a los campos públicos estáticos y protegidos. No debería definir campos de instancia como públicos o protegidos. Para obtener más información, vea Diseño de campos.

Utilice la grafía Pascal para los nombres de campos.

Denomine los campos con nombres o sintagmas nominales.

No utilice prefijos en los nombres de campos. Por ejemplo, no utilice g_ o s_ para distinguir los campos estáticos de los no estáticos.

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