Evita dolores de cabeza al revisar tu código

En el mundo de desarrolladores de software, hay una medida para establecer la calidad del código. Descubre cómo mejorar esta métrica.

Una forma de mejorar su código es reducir las WTF / minuto cuando alguien más (o usted mismo) revisa el código.

Un buen código no es solo un código que funciona y que las máquinas pueden ejecutar de manera eficiente. Un buen código también es un código funcional que los humanos pueden leer y comprender.

Un famoso cómic de Thom Holwerda dio en el clavo. El código bueno y malo se pueden distinguir de acuerdo con los WTF por minuto expresados al momento de revisarlo.

Así que si evitas que el revisor (que podría ser tú mismo) haga expresiones como:

“¿Que demonios es eso?”

“¿Qué hiciste aquí?”

“¿Para qué diablos es esto?”

… tu código podría considerarse de buena calidad

Algunos programadores piensan erróneamente que un código incorrecto los hará esenciales en una empresa. Como son los únicos disponibles para comprender el código, serán necesarios en el futuro. Sin embargo, la verdad es que la baja calidad será un dolor de cabeza incluso para tu yo del futuro. Ser imprescindible no es una ventaja en los días de vacaciones, por ejemplo. Por otro lado, el código de buena calidad facilita la colaboración y la revisión del código.

Dicho esto, ¿hay alguna manera de reducir las WTF / minuto para mejorar su código? ¡Por supuesto que la hay! Mantener un código limpio ayudará a las personas futuras a continuar con su trabajo (esa persona futura podría ser usted mismo).

Puede reducir las WTF / Minuto siguiendo estos dos puntos clave

  • Comprobación de tipos
  • Buenos nombres
  • Verificación de tipos

Los lenguajes como JavaScript pueden producir resultados inesperados debido a que están mal escritos. Hoy en día, existen formas de resolver estos problemas con éxito con comprobaciones de tipo estrictas. Por ejemplo, en JS, es una buena práctica usar “===” en lugar de “==” para evitar problemas comunes del lenguaje de programación. Los tipos débiles pueden ser un dolor de cabeza.

Da nombres descriptivos a las variables y funciones

Nombrar una variable como x es bueno para los libros de matemáticas, pero es una idea terrible para codificar la mayor parte del tiempo. Una buena práctica es nombrar las variables de manera que revelen su intención. Hacer eso brinda algunas ventajas al revisar y refactorizar el código: son más fáciles de buscar y más fáciles de entender después de que una persona los ve.

// Código incorrecto

x = ‘manzana’

// Buen código

fruta = ‘manzana’

Los nombres de las variables deben ser lo suficientemente cortos para escribir rápido, pero lo suficientemente largos para que se entiendan. Como recomendación, la longitud puede ser de 1 carácter para contadores de bucle, 1 palabra para variables de condición / bucle, 1-2 palabras para métodos, 2-3 palabras para clases, 3-4 palabras para globales.

Procure utilizar nombres específicos para las variables. Nombrar variables como “valor”, “igual”, “datos” no es una buena idea en la mayoría de los casos. En lugar de eso, usa nombres significativos para las variables. Un nombre de variable debe definir la explicación exacta de su contenido.

Puedes consultar aquí un ejemplo de reglas para nombrar variables.

¿Qué más puedes hacer para reducir WTFs / Minuto?

Otras buenas sugerencias para reducir WTFS / Minute son mantener su código simple y seguir el principio DRY (Don’t Repeat Yourself).

Es más fácil solicitar simplicidad que hacerlo, como revela esta discusión en StackOverflow. Entre las recomendaciones para la simplicidad del código se encuentran los tipos de datos sólidos, prefiera un código claro que comentar. Además, se sugiere refactorizar periódicamente su código para hacerlo de formas más simples.

Lee también: Aprender a programar: otra guía para el principiante