.NET Buenas Prácticas – Clases, estructuras e interfaces


Las clases y estructuras deben usar nomenclatura Pascal y deben tener nombre de sustantivos o frases de sustantivos, por ejemplo: “Car” o “CarType”.
De esta forma se diferencian de los métodos que son frases verbales.

Las interfaces deben usar nombres de frases de adjetivo, o de vez en cuando con nombres o frases nominales. Sustantivos y compuestos deben ser utilizados en raras ocasiones ya que podrían indicar que el tipo debe ser una clase abstracta, y no una interfaz. Por ejemplo: “IFormatable”.

No usar prefijos en ningún caso. Solo las interfaces deben incluir el prefijo “I”, por ejemplo: “IComparable”

En la mayoría de las ocasiones se recomienda terminar el nombre con el de la base clase, por ejemplo: “ArgumentOutOfRangeException”. De esta forma se da claridad y relación, pero hay ocasiones en las cuales no debería usarse (la clase Button es de tipo Control, pero no por eso se la denomina ButtonControl). Queda a consideración de cada uno si lo incluye o no, pero en muchas ocasiones es mejor agregar la clase base al nombre.

Nomenclatura para tipos que heredan de tipos base

Atributos (System.Attribute): Agregar sufijo “Attribute”

Delegados (System.Delegate): Agregar sufijo “EventHandler” para los eventos y “Callback” para los que no son eventos. Nunca usar “Delegate”.

Argumentos de Eventos (System.EventArgs): Agregar sufijo “EventArgs”.

Enumeradores (System.Enum): Nunca usar prefijos ni sufijos como por ejemplo “Enum” o “Flag”.

Excepciones (System.Exception): Usar sufijo “Exception”.

Colecciones (IEnumerable, ICollection, IList, IEnumerable, ICollection, IList): Usar sufijo “Collection”.

Flujos (System.Stream): Usar sufijo “Stream”.

Permisos (CodeAccessPermission, IPermission): Usar sufijo “Permission”.

Enumeradores

Utilizar un nombre de tipo singular para una enumeración a menos que sus valores son campos de bits.

Utilizar un nombre de tipo plural para una enumeración con campos de bits como valores, o los denominados “banderas/flags”.

Nunca usar el sufijo ni prefijo “Enum” o “Flag”.

Nunca utilizar ningún tipo de prefijo.

Anuncios

1 comentario

Archivado bajo Buenas Prácticas, Código

Una respuesta a “.NET Buenas Prácticas – Clases, estructuras e interfaces

  1. Pingback: .NET Buenas Prácticas | Desarrollo y Arquitectura de Software

Responder

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión /  Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión /  Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión /  Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión /  Cambiar )

w

Conectando a %s