Clean Code. Formato vertical y horizontal.

Se describen una serie de prácticas que debes seguir para que tu código sea más fácil leer y mantener.

FORMATO VERTICAL

  • El tamaño del documento no debería superar las 200 líneas de media, con un límite máximo en 500 líneas.
  • Debe haber solamente una declaración por línea.
  • Debe haber solamente instrucción por línea.
  • Hay que usar el espacio en blanco para separar Métodos y disociar las cosas.
  • Indentar para que sea más sencillo de leer.
    Hay que intentar no romper nunca las reglas de sangrado.

    Teclas para indentar el código en Visual Studio CTRL + K, D
  • Las instancias de las variables deben estar al inicio de la clase, ya que se usarán en toda ella.
  • Las variables locales hay que declararlas cuando se vayan a necesitar, dentro de su ámbito para que se liberen antes.
  • Las funciones se deben ordenar por su nivel del más alto al  más bajo.
    1) Contantes publicas estáticas.
    2) Variables publicas estáticas.
    3) Instancias privadas estáticas.
    4) Funciones Publicas.
    5) Funciones Privadas.
  • Las funciones dependientes debes estar lo más cerca posible.
  • Las funciones con operaciones parecidas (código afín) se deben intentar agrupar.

FORMATO HORIZONTAL:

  • Las líneas  deben ser cortas no más de 80 /120 caracteres.(no se debe necesitar el scroll horizontal).
  • No se debe usar la tabulación  en la definición de variables.

    A mi parecer hay que intentar aplicarlas siempre que sea posible y es fundamental llegar a un consenso con el equipo para que el código quede coherente, facilitando su lectura y mantenimiento por todo el equipo.

    Fuentes: Microsoft Convenciones del código C#, Libro Clean Code.

Deja un comentario