¿QUÉ ES EL CÓDIGO LIMPIO?

El Código Limpio es una filosofía de desarrollo de software que consiste en aplicar técnicas sencillas que facilitan la escritura y la lectura del código, haciéndolo más fácil de entender.

¿Cuándo surgió el término Código Limpio? Las técnicas de código limpio aparecieron por primera vez en el libro "Clean Code: A Handbook of Agile Software Craftsmanship", publicado en 2008. Fue escrito por Robert Cecil Martin, conocido en la comunidad como Tío Bob. El autor lleva trabajando en desarrollo y programación desde 1970 y es uno de los profesionales que lideró el Manifiesto Ágil en 2001.

¿Para qué se considera Código Limpio? Un código con muchos ajustes durante mucho tiempo se vuelve imposible de mantener, por lo que es mejor crear un nuevo código y no continuar con una versión problemática. Un código limpio evita gastos innecesarios y prepara el software para actualizaciones y mejoras.

Conozca las 7 reglas principales del Código Limpio

El libro del tío Bob enumera las buenas prácticas para un código limpio. Las principales son:

1 - Los nombres son importantes La definición del nombre es esencial para la comprensión de un código. Aquí no importa el tipo de nombre, sean estos Variable; Función; Parámetro; Clase; Método.

A la hora de definir un nombre, es necesario tener en cuenta dos aspectos principales: Debe ser preciso y transmitir la idea central. Es decir, debe ir directamente al grano; No te preocupes por los nombres grandes. Si la función o parámetro necesita un nombre largo para demostrar lo que realmente representa, eso es lo que debes hacer.

2 - Regla del Boy Scout Hay un principio que dice que, si dejas la zona en la que estás acampando, debes dejarla más limpia que cuando la encontraste. Si llevamos esta regla al mundo de la programación, podemos adaptarla como dejar el código más limpio de lo que estaba antes de editarlo.

3 - Debes ser el verdadero autor del código Los seres humanos están acostumbrados a pensar de forma narrativa, así que el código funciona de la misma manera. Se trata de una historia y, como los programadores son sus autores, deben preocuparse por cómo se presentará esta historia. En resumen, para estructurar un código limpio, es necesario crear funciones simples, claras y pequeñas. Hay dos reglas para crear la narrativa del código: Las funciones deben ser pequeñas; Deben ser aún más pequeñas. No confunda los términos "nombre" y "función". Como dijimos en el primer principio, los nombres grandes no son un problema, pero las funciones sí.

4 - DRY (Don't Repeat Yourself) Este principio puede traducirse como "no te repitas". Una expresión, que fue descrita por primera vez en un libro llamado The Pragmatic Programmer y se aplica a las áreas de desarrollo, tales como: Banco de datos; Pruebas; Documentación; Codificación.

DRY defiende que cada parte del conocimiento de un sistema debe tener una representación única y estar libre de ambigüedades. En otras palabras, define que no hay dos partes del programa que puedan realizar la misma función.

5 - Comentar sólo lo necesario Este principio establece que se pueden hacer comentarios; sin embargo, deben ser necesarios. Según el tío Bob, los comentarios mienten; y esto tiene una explicación lógica. Lo que ocurre es que, mientras los códigos se modifican, los comentarios no. Se olvidan, y por tanto, no retratan la funcionalidad real de los códigos. Así que ya sabes; si vas a comentar el código, que sea sólo lo necesario y que se revise junto con la versión del código que lo acompaña.

6 - Manejo de errores Hay una frase del autor Michael Feathers, muy conocida en el ámbito del desarrollo web, que dice que las cosas pueden salir mal; pero cuando esto ocurre, los programadores son responsables de que el código siga haciendo lo que tiene que hacer. En otras palabras, manejar las excepciones correctamente es un gran paso para el programador en desarrollo.

7 - Pruebas limpias Realizar pruebas en el área de programación es un paso muy importante. Un código sólo se considera limpio después de ser válido a través de pruebas, que también deben ser limpias. Por esta razón, deben seguir algunas reglas, tales como

Rapidez: La prueba debe ser rápida, permitiendo que se realice muchas veces y en cualquier momento.

Independiente: Debe ser independiente, para evitar que se produzca un efecto cascada cuando se produzca un fallo, que dificulte el análisis de los problemas; Repetible: Debe permitir la repetición de la prueba, muchas veces y en diferentes entornos.

Autovalidación: Las pruebas bien escritas devuelven respuestas verdaderas o falsas para que el error no sea subjetivo.

Puntualidad: Las pruebas deben seguir estrictamente los criterios de puntualidad. Además, lo ideal es que se escriban antes que el propio código, ya que así se evita que sea demasiado complejo realizar la prueba.

El Código Limpio es un concepto que llegó y se quedó. Sus principios resuelven eficazmente uno de los principales problemas a los que se enfrentan la mayoría de los proyectos de sistemas: el mantenimiento.