Las buenas practicas para escribir código.

Después de leer varias fuentes aquí les comparto algunos conceptos que considero fundamentales a la hora de escribir un código, para facilitar a otros usuarios su lectura y entendimiento.

Existente tantas definiciones de código limpio, como programadores. Si consideras que algo de lo aquí mencionado no aplica en tu caso, favor de omitirlo. Si tienes alguna aportación, compártela en los comentarios.

 

Las buenas practicas para escribir código.

  • Desarrollo en capas. Estrategia de programación que separa las funcionalidades, de tal forma que al requerir un cambio solo se afecta un segmento especifico del código.
  • Indentado. Cada bloque de código esta distinguido del resto mediante sangrías o tabulaciones. Identificando fácilmente el principio y fin de cada bloque.
  • Iterativo. Si un bloque de código se repite en más de dos ocasiones, entonces necesitas un ciclo iterativo.
  • Sin Dependencias. Cuando un código hace uso de una función no descrita en el proyecto, dicha función se puede convertir en una caja negra.
  • Parametrizable. Haciendo uso de variables, podemos llevar de manera consistente un dato a las distintas funciones que lo requieren.
  • Portabilidad. El código es fácilmente ejecutable desde otro equipo, sin requerir mayor actualización que la de los parámetros.
  • Documentado puntualmente. Comentarios que explican la funcionalidad esperada de un código.

 

La estructura que recomiendo en un proyecto.

  • Librerías.
    • Definición de Variables.
    • Definición de Librerías.
    • Definición de Formatos.
  • Importacion.
    • Carga de archivos.
    • Transformación.
    • Muestreo.
  • PreProceso.
    • Procesamiento previo de la información.
  • Proceso.
    • Procesamiento definitivo de la información
    • Muestreo.
  • Exportación.
    • Exportación de Resultados.
    • Impresión de Resultados.

 

Código Limpio.

Robert Cecil Martin, más conocido como Uncle Bob  (Tío Bob) es un programador estadounidense, dedicado a la consultoría y la escritura de sus libros, con más de 40 años de experiencia. Es fundador de Object Mentor, empresa de formación en C++, Java, programación orientada a objetos, metodologías ágiles y Extreme Programming, además fue uno de los miembros firmantes del "Manifiesto Ágil para el desarrollo de software"

Este libro examina en sus capítulos cada mínimo detalle para conseguir un código lo más conciso y legible, desde comentarios hasta la indentación y muchísimo mas.  El libro esta disponible en formato digital las siguientes paginas: A, B, C, D.

 

Un resumen del libro en video.

Hi Por favor permite que el video llegue al final para que cuente como una reproduccion. Gracias.

WrbDaqKyhP4

 

Lecturas encontradas durante la redacción de este post.

 

¿En tu opinión cual seria una buena practica a la hora de programar?

¿Que te parecio el contenido?