El código limpio es una filosofía de desarrollo de software que consiste en aplicar técnicas simples que facilitan la escritura y 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 Uncle Bob. El autor ha estado 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 el 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 seguir con una versión problemática. Un código limpio evita gastos innecesarios y prepara el software para actualizaciones y mejoras.
Conoce las 7 reglas principales del Código Limpio
El libro de Uncle Bob enumera buenas prácticas para el 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, ya sea:
- Variable.
- Función.
- Parámetro.
- Clase.
- Método.
Al definir un nombre, es necesario tener en cuenta dos aspectos principales:
Debe ser preciso y entregar la idea central. Es decir, debe ir directo al grano; No te preocupes por los nombres grandes. Si la función o el 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 establece que, si abandonas el área en la que estás acampando, debes dejarla más limpia de lo que la encontraste. Si llevamos esta regla al mundo de la programación, podemos adaptarla a 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 narrativamente, así que el código funciona de la misma manera. Esta es 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 confundas los términos "nombre" y "función". Como dijimos en el primer principio, los nombres grandes no son un problema, pero las funciones sí lo son.
4 - DRY (Don't Repeat Yourself) Este principio se puede traducir como "no te repitas". Una expresión, que fue descrita por primera vez en un libro llamado "The Pragmatic Programmer" y se aplica a áreas de desarrollo, como:
- Base 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 ninguna parte del programa puede realizar la misma función.
5 - Comentar solo lo necesario Este principio establece que se pueden hacer comentarios; sin embargo, deben ser necesarios. Según Uncle Bob, los comentarios mienten; y esto tiene una explicación lógica. Lo que sucede es que, mientras los códigos se modifican, los comentarios no. Se olvidan y, por lo tanto, no representan la funcionalidad real de los códigos. Entonces, ya sabes; si vas a comentar el código, que sea solo lo necesario y revísalo junto con la versión del código que lo acompaña.
6 - Manejo de errores Hay una frase del autor Michael Feathers, bien conocido en el área de desarrollo web, que dice que las cosas pueden salir mal; pero cuando esto sucede, los programadores son responsables de asegurarse de que el código siga haciendo lo que necesita 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 solo 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, como:
- Rápidas: La prueba debe ser rápida, lo que permite realizarla muchas veces y en cualquier momento.
- Independientes: Debe ser independiente, para evitar causar un efecto cascada cuando ocurre un fallo, lo que dificulta el análisis de los problemas.
- Repetibles: 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.
- Oportuna: Las pruebas deben seguir estrictamente los criterios de oportunidad. Además de esto, idealmente deberían escribirse antes del código en sí, ya que esto evita que sea demasiado complejo realizar la prueba.
El código limpio es un concepto que llegó para quedarse. Sus principios resuelven de manera efectiva uno de los principales problemas que enfrentan la mayoría de los proyectos de sistemas: el mantenimiento.
