En el artículo sobre cómo escribir código limpio y legible hablamos de la necesidad de un código que no tenga bloques de código inútil.
Estos bloques de código inútil se originan normalmente cuando estamos probando un código de forma temporal para hacer un experimento en nuestro proyecto.
Activando y desactivando bloques de código
Dentro de un proyecto de software puede que durante una ejecución de prueba controlada nos interese desactivar un bloque de código y activar otro. Esto se consigue gracias a las instrucciones para añadir comentarios en un código.
Cada lenguaje de programación posee uno o varios métodos para comentar un trozo de código. Por ejemplo la función original sería:
Funcion calcularImpuesto() {
calcularImpuestosDelCarrito()
}
Y para nuestro experimento quedaría así:
Funcion calcularImpuesto() {
// Comentamos la siguiente línea para la prueba
// calcularImpuestosDelCarrito()
// Usamos el experimento
calcularImpuestosDelCarritoDeOtraForma()
}
El problema
El problema aparece cuando dejamos esos comentarios porque nos ha gustado más el resultado de la prueba. El código resultante está lleno de bloques inútiles que dificultan la lectura del código.
La solución consiste en quitar esos bloques de código y dejar sólo el código útil. El ejemplo quedaría al final así:
Funcion calcularImpuesto() {
calcularImpuestosDelCarritoDeOtraForma()
}
¿Cómo no perder esos bloques comentados?
Puede que para nuestro proyecto nos interese no perder ese código alternativo que al principio estaba desactivado con comentarios y que posteriormente borramos para mejorar la limpieza de nuestro código.
Para evitar perder este código alternativo lo mejor es utilizar un sistema de gestión de versiones de código como Git o Mercurial.
Con estas herramientas podemos tener varias versiones de nuestro proyecto e ir manteniendo el código límpio en todo momento sin perder nada ya que con la herramienta de gestión de versiones podemos consultar código más viejo en cualquier momento.