Buenas prácticas de programación

¿Por qué es necesario aplicar buenas prácticas de programación?

Como programadores una de las tareas más aburridas es la de documentar los proyectos. Sin embargo es muy valioso contar con una buena documentación al momento en el que surgen los problemas.

Cuando desarrollamos software es importante incluir el proceso de documentar al momento de escribir el código, cuando las ideas aún están frescas. Nunca después de terminar el proyecto, ya que puede frustrar darse cuenta de que en un breve periodo de tiempo lo que expresamos en el código ya se nos ha olvidado.

Es importante adoptar buenas prácticas para escribir el código y la documentación.

Hay un dicho que me gusta porque menciona que un programador con un excelente estilo para escribir código legible no necesita documentación.

El buen código es la mejor documentación: cuando estés a punto de agregar un comentario pregúntate “¿Qué puedo mejorar en el código para que este comentario no sea necesario?”, mejora el código y luego documenta lo más claro posible. - Steve McConnell

Una de las cosas que debes de recordar es que la memoria te puede fallar y no siempre trabajaras solo. Para lo cual escribir buen código es una obligación, habla bien de ti y demuestra respeto hacia los demás. La mayor parte del tiempo nos la pasamos revisando código que escriben otros programadores y es motivo de frustración intentar adivinar el objetivo de un programa sin documentación.

Imagínate que las librerías de código que utilizas o el framework que quieres aprender no tienen documentación, ¡sería aún más complicado aprender a programar no!, pues justamente por eso todo el código que produces deberá estar muy bien estructurado y con su documentación.

La mayoría de los programadores sabemos que la mayor parte del tiempo tenemos que leer mucho código y programar lo esencial, intentamos crear aplicaciones funcionales con el menor código que sea posible.

“La legibilidad cuenta” - Adoptar una convención para la escritura de código nos ayuda a que el mantenimiento o refactorización sean procesos menos dolorosos, sin dolores de cabeza. Haciendo que nuestro código sea más legible para otros programadores como para nosotros mismos.

“Medir el progreso del desarrollo de software por líneas de código es como medir el progreso de la construcción de un avión por su peso” – Bill Gates

Ideas para mejorar como programador

  • Nombre de variables, clases o métodos más descriptivos.
  • Siempre pon atención a la indentación del código.

Todo debe ser lo más simple posible, no solo simple - Albert Einstein

  • Crea o adopta un estándar para escribir código.
  • Decide entre tabulación o espacios.

“Codifica siempre como si el tipo que finalmente mantendrá tu código fuera un psicópata violento que sabe dónde vives.” - Rick Osborne

  • Longitud de línea no mayores a 120 caracteres.
  • Agrupar código en funciones o clases.

La perfección se logra cuando no queda nada por quitar, todo lo demás viene sobrando.

  • Adopta buenas prácticas para documentar tu código.
  • Crea comentarios en el código que sumen valor.

La simplicidad es la sofisticación extrema - Leonardo Da Vinci

  • Nunca documentes el problema; mejor soluciónalo y después codifícalo.