Los bad smells son unos síntomas que muestra nuestro código, y nos indica que algo no está bien diseñado o que la implementación elegida es incorrecta.
Al proceso de mejorar el código, sin cambiar el funcionamiento interno del mismo, se le llama refactorización.
Algunos ejemplos de bad smells son:
- Código duplicado: cuando hay bloques de código que se repiten en distintas partes del programa, lo cual dificulta su mantenimiento y aumenta la probabilidad de errores.
- Métodos o funciones demasiado largas: si un método o función tiene muchas líneas de código, puede ser difícil de entender y mantener. Además, puede indicar que se están haciendo demasiadas cosas en un solo lugar.
- Clases o módulos demasiado grandes: lo mismo que el punto anterior, pero a nivel de estructura del programa. Las clases o módulos demasiado grandes pueden ser difíciles de entender y manejar, y pueden indicar que se están haciendo demasiadas cosas en un solo lugar.
- Comentarios innecesarios: los comentarios que simplemente repiten lo que el código ya está diciendo no son necesarios y solo agregan ruido al código. Además, los comentarios pueden volverse obsoletos si el código cambia y no se actualizan.
- Nombres de variables, métodos o clases poco claros: los nombres deben ser descriptivos y significativos. Si los nombres no son claros, se hace más difícil entender el código.
- Código demasiado complejo: el código que es difícil de entender y seguir puede ser un signo de que se está utilizando una lógica compleja innecesariamente. Esto puede dificultar el mantenimiento y aumentar la probabilidad de errores.
- Falta de pruebas automatizadas: las pruebas automatizadas son esenciales para garantizar la calidad del código. Si el código no tiene pruebas automatizadas, es difícil estar seguro de que funciona correctamente y es fácil de mantener.
- Dependencias no manejadas: si el código tiene muchas dependencias externas y no se manejan adecuadamente, puede ser difícil de mantener y actualizar.
- Falta de coherencia: el código que no sigue las convenciones de estilo o de nomenclatura puede ser difícil de entender y seguir. Además, si hay diferentes estilos de código en diferentes partes del programa, puede ser confuso y dificultar el mantenimiento.
- Código muerto: el código que no se usa debe ser eliminado ya que solo agrega peso innecesario al proyecto y puede confundir a los desarrolladores que tratan de entender el código.
- Ausencia de manejo de errores: cuando el código no maneja adecuadamente las excepciones y errores, puede provocar errores en tiempo de ejecución y dificultar la depuración.
¿ Por qué es importante escribir código mantenible ?
- El código será más fácil de entender.
- Será más fácil de cambiar.
- Los cambios tardarán menos y así serán más baratos