Clean Code

Post en desarrollo...

ūüíłDeuda t√©cnica

¬ŅC√≥mo se paga la deuda t√©cnica?

Refactorización: Es un proceso que tiene como objetivo mejorar el código sin alterar su comportamiento para que sea más entendible y tolerante a cambios. Es imprescindible contar con pruebas automáticas.

ūüĖĆClean Code

Recomendaciones para nombres de variables

  • Expresivos
  • Pronunciables
  • Escritos en ingl√©s
  • Usar camelCase

Ejemplos seg√ļn el tipo de dato

Arrays

const fruitNames = ['apple', 'banana', 'orange'];

Booleans

const isOpen = true;
const canWrite = true;
const hasValues = false;

Number

const maxFruits = 5;
const minFruits = 1;
const totalOfCars = 10;

Function (que el nombre diga exactamente que hace la función)

createUser();
updateUser();
sendEmail();
getEmail();

Recomendaciones para funciones

  • Simplicidad es fundamental
  • Funciones de tama√Īo reducido
  • Funciones de una sola l√≠nea sin causar complejidad
  • Menos de 20 l√≠neas
  • Evitar el uso del ‚Äúelse‚ÄĚ
  • Prioriza el uso de la condicional ternaria

Principio DRY (Don’t repeat yourself)

  • Evitar tener duplicidad de c√≥digo
  • Simplifica pruebas
  • Centraliza los procesos
  • Aplicar el principio DRY, usualmente lleva a refactorizar

Comentarios

‚ÄúNo comentes el c√≥digo mal escrito, reescr√≠belo‚ÄĚ -Brian W. Kernighan

Nuestro código debe ser suficientemente auto explicativo, podemos usar comentarios cuando usamos librerías de terceros en caso de ser necesario explicar algo.

Uniformidad en el proyecto

Problemas similares, soluciones similares.

  • Estructuras de directorios
  • Nombres de funciones
  • Indentaci√≥n