El día de ayer comenzamos a ver las mejores prácticas al momento de escribir nombres de los objetos, hoy nos corresponde ver la forma correcta de espaciado para darle mejor orden al código escrito.
Usa la tecla TAB para las tabulaciones. No uses espacios. Define el tamaño del tabulador en número 4.
Los comentarios deben estar al mismo nivel que el código (usa el mismo nivel de tabulación).
//Esta es la clase que utilizarás en la lista //No es necesario colocar atributos adicionales public class Elemento { public int Identificador { get; set; } public string Nombre { get; set; } public string Mensaje { get; set; } public string Imagen { get; set; } } |
Las llaves { } deben estar en el mismo nivel que el código sobre ellas.
public class Elemento { public int Identificador { get; set; } public string Nombre { get; set; } public string Mensaje { get; set; } public string Imagen { get; set; } } |
Usa una línea en blanco para separar los grupos lógicos de código.
private void ObtenerListaDeElementos(UIElement padre, Type tipoPresentacion, Type tipoVideo, Type tipoImagen, Type tipoNavegador) { int contador = VisualTreeHelper.GetChildrenCount(padre); for (int i = 0; i < contador; i++) { UIElement hijo = (UIElement)VisualTreeHelper.GetChild(padre, i); if (hijo.GetType() == tipoPresentacion) { int valorIndice = master.LayoutRoot.Children.IndexOf(hijo); ModificarPosicionElementosPresentacion(valorIndice); } if (hijo.GetType() == tipoVideo) { int valorIndice = master.LayoutRoot.Children.IndexOf(hijo); ModificarPosicionElementosVideo(valorIndice); } } } |
Debería haber solo una (si, solo UNA) línea en blanco entre cada método dentro de la clase.
private void Metodo1(object argumento, object argumento2) { //Funcionalidad de método } private void Metodo2(object argumento, object argumento2) { //Funcionalidad de método } |
Las llaves deben estar en una línea separada y no en la misma línea que las inicia.
private void Metodo(object argumento, object argumento2) { if (elmento == true) { } } |
Usa un solo espacio antes y después de cada operador y paréntesis.
private void Metodo(object argumento, object argumento2) { for (int i = 0; i < length; i++) { } } |
Usa una #region para agrupar piezas de código similares juntas. Si usas una agrupación correcta usando las regiones tu código deberá verse así al final.
Mantén las variables, propiedades y métodos privados al inicio del código, y los públicos al final. No los debes mezclar.
Conclusión
La misma de ayer y de mañana, recuerda que entre mas estandarizado esté tu código, mas factible será poder compartirlo sin mayor problema y/o entender el de tu equipo, así como entenderte tu mismo.