Las mejores prácticas para hacer código limpio

El código limpio es un fin en la programación al que llegamos a través de distintas prácticas para mejorar la legibilidad, mantenimiento y simplicidad del código. Escribir código de esta forma es esencial para que los desarrolladores que lleguen a colaborar en el proyecto puedan entender y modificar el código sin que llegue a haber un error y todo el proceso sea más eficiente. Incluso para uno mismo porque a todos nos ha pasado que te piden realizar modificaciones a un proyecto antiguo y no entiendes cómo funciona y lo peor, es que lo hiciste tú! 

¿Por qué escribir código limpio?

1. Legibilidad: con esto nos referimos a que el código sea fácil de leer y entender, haciendo que las actualizaciones o nuevas features sean más efectivas. Con esto, debes mantener tu código organizado y bien estructurado.
2. Mantenimiento: el código limpio es mucho más fácil de actualizar con el tiempo ya que puedes detectar un problema fácilmente gracias a la estructuración y organización de este. Esto puede ayudarte a ser más productivo y perder menos tiempo.
3. Colaboración: Si en el proyecto en el que trabajas hay varias personas involucradas, el código limpio ayudará a que varios desarrolladores puedan estar trabajando sobre la misma base sin que se pongan el pie uno al otro. 
4. Eficiencia: Si tu código es limpio, está bien organizado y además reutilizan código, tu programa será mucho más rápido y usará menos memoria.
5. Reusabilidad: Lo más importante a la hora de hacer código limpio, es reutilizar código. A veces una función puede ser utilizada para varias partes del proyecto. Ahorrará tiempo, memoria.

Pasaremos a ver algunas prácticas que te ayudarán a hacer tu programa más limpio, proporcionaremos algunos ejemplos en Java:

1. Nombres de variables

Al crear variables es indispensable que le des un nombre que tenga significado para que al leer la variable, te puedas dar una idea de lo que está almacenando.

# Mala práctica
int x = 5
# Buena práctica
int edad = 5

2. Formato

Debes ser consistente en el formato que ocuparás al programar, normalmente hay varias formas de darle formato, en lo personal, a nosotros nos gusta usar tabs.

# Mala práctica
public void edad(int x){
  System.out.println(“Edad: ” + x);
}
# Buena práctica
public void edad(int edad){
  System.out.println(“Edad: “ + edad);
}
public void imprimirEdad(int edad)
{
  System.out.println(“Edad: “ + edad);
}

3. Uso de comentarios

Los comentarios solo deberían realizarse cuando sean necesarios. Dándole nombres a tus variables y a las funciones de lo que hace o tienen almacenado, no será necesario utilizar comentarios.

# Mala práctica
# Esta función imprime la edad de la persona
public void Edad(int x){
  #Aquí imprime la edad
  System.out.println(“Edad: “ + x);
}

# Buena práctica
public void imprimirEdad(int edad)
{
  System.out.println(“Edad: “ + edad);
}

4. Usa try y catch para las excepciones

A veces le puedes estar pidiendo al usuario un número y te otorgan una letra. Esto provocará una excepción y el programa se detendrá.

# Mala práctica
public void int division(int num1, int num2){
  int resultado = num1 / num2;
  return resultado;
}

# Buena práctica
public void int division(int num1, int num2){
  try{
    int resultado = num1 / num2;
    return resultado;
  } catch(DivideByZeroException e){
      System.out.println(“No se puede dividir entre 0”);
  }
}

5. Descripción de excepciones

Al obtener una excepción, debes informarle al usuario lo que está ocurriendo y/o el origen del error para que pueda solucionarlo. Usemos el ejemplo anterior: 

# Mala práctica
public void int division(int num1, int num2){
  try{
    int resultado = num1 / num2;
    return resultado;
  } catch(DivideByZeroException e){
    System.out.println(“Error”);
  }
}

# Buena práctica
public void int division(int num1, int num2){
  try{
    int resultado = num1 / num2;
    return resultado;
  }catch(DivideByZeroException e){
    System.out.println(“No se puede dividir entre 0”);
  }
}

6. Evita el código duplicado

En muchas ocasiones verás que el código se repite constantemente y para evitar eso, puedes hacer uso de métodos, clases, etc. 

# Mala práctica
public static void main(str[]){
System.out.println(“1 / 2 = “ + (1 / 2));
System.out.println(“1 / 2 = “ + (3 / 7));
System.out.println(“1 / 2 = “ + (4 / 2));
System.out.println(“1 / 2 = “ + (16 / 8));
}

# Buena práctica
public void int division(int num1, int num2){
try{
int resultado = num1 / num2;
System.out.println(num1 + “ / ” + num2 + “ = “ + resultado);
} catch(DivideByZeroException e){
System.out.println(“No se puede dividir entre 0”);
}
}

public static void main(str[]){
division(1,2);
division(3,7);
division(4,2);
division(16/8);
}

En conclusión, escribir código limpio ayudará a la legibilidad, eficiencia, colaboración y más de tu código. Ayudará a que te ahorres tiempo, haya menos errores y sea más fácil de modificar o actualizar.

Hay muchas prácticas para hacer código limpio pero con estas podrás mejorar en la forma en la que programas. Esperamos te sirva en tu próximo proyecto!