Si bien puede ser una deliciosa cena italiana, una de las últimas cosas que desea escuchar sobre su base de código es Espaguetis. La idea de que su código está tan enredado como un plato de espagueti da miedo, pero para muchos programadores la idea es tan abstracta que no pueden manejarla (o entender cómo evitarla o arreglarla). Por lo tanto, en esta publicación queremos profundizar en qué es realmente el código espagueti, mostrarle algunas de las mejores prácticas sobre cómo evitarlo y (si lo hace) cómo lidiar con él.
Suscríbete a nuestro canal de YouTube
¿Qué es el código espagueti?
El código espagueti es una pesadilla, eso es. Como dijimos anteriormente, el término de la jerga recibió su nombre porque, como una maraña gigantesca de espaguetis, si tiras de un hilo (pieza de código), eventualmente se tuerce en el siguiente y el siguiente y el siguiente hasta que las piezas enredadas estallan. .
Por ejemplo, piense en la propiedad !Important en CSS. Es increíblemente potente, ya que permite al diseñador sobrescribir estilos heredados y controlar cualquier elemento sin tener que recodificar toda la hoja de estilo. Sin embargo, cuando ellos (o los futuros desarrolladores y diseñadores) necesitan cambiar algo, pueden agregar algo más. !importante etiqueta para reemplazar la anterior. Y así. Sin embargo, si regresa y elimina o cambia cualquiera de los que están en esa pila, cualquier número de estilos en la página puede romperse.
Esto es lo que estamos tratando de evitar.
Mejores prácticas para evitar el código spaghetti
1. Desarrollar estándares de codificación
La mejor manera de evitar la codificación espagueti es crear y codificar estándares en su organización o proyecto. Los estándares de codificación hacen posibles proyectos como WordPress. Miles de desarrolladores han trabajado en WP Core, pero los estándares de codificación de WordPress han hecho que todos trabajen con las mismas pautas y completen tareas con los mismos parámetros de la misma manera.
Los estándares de codificación son solo las reglas que usted aplica. Se aseguran de que cada código siga el mismo patrón, lo que hace que los errores sean fáciles de encontrar y corregir, y los futuros desarrolladores (e incluso usted o su equipo actual) pueden saber exactamente qué está haciendo cada línea de código de la manera más eficiente posible. Si el código de Susan falla en las pruebas, no entra. Si el código de Janine no tiene pruebas para ejecutar, se rechaza la solicitud de extracción. Tal vez Daniel no esté usando el div en su última solicitud de extracción. No unirse hasta que las cosas se separen.
Además, algunas de las bases de código originales que estaban plagadas de código espagueti eran lenguajes más antiguos sin lógica funcional. El código no estaba basado en funciones, por lo que la lógica diferente apuntaba a líneas específicas en el código. Para proyectos pequeños, no es tan malo navegar. Cuando comienza a escalar proyectos, tener referencias directas a archivos y líneas de código específicos puede dificultar este desarrollo. Los archivos pueden perderse, las líneas pueden borrarse o estar mal numeradas. Y depurarlo para averiguar qué trozo de espagueti se ha extraído puede llevar cientos de horas-persona. Tener estándares de codificación implementados puede evitar que este tipo de desorden suceda de vez en cuando.
Por lo tanto, al desarrollar los estándares, redujo de manera muy efectiva las posibilidades de tener un repositorio de código espagueti. Si desea obtener más información sobre los estándares de codificación en general, GeeksforGeeks tiene una excelente guía.
2. Sigue la guía de estilo
Además de los estándares de codificación, tener una guía de estilo a seguir también puede evitar demasiado desorden en el código. Si bien esto puede sonar similar en teoría, los dos son muy diferentes. Los estándares de codificación son reglas aplicables que siguen sus desarrolladores para mantener su código funcionando de manera eficiente. Pueden cambiar de un proyecto a otro o de un equipo a otro dentro de una organización.
Sin embargo, la guía de estilo generalmente se escribe idioma por idioma y proporciona una serie de mejores prácticas para mantener su código legible y funcional. Por ejemplo, Airbnb ha creado una de las mejores guías de estilo para React.js Por ahí. Si no eres un desarrollador de React, no significa nada. Pero para los desarrolladores de React, una mirada realmente puede ayudar con la forma en que su código debe estructurarse y escribirse para que sea lo más accesible posible para los futuros desarrolladores.
La guía de estilo, a diferencia de los estándares generales de codificación, no son necesariamente reglas aplicables. Estas son sugerencias para estandarizar el código, haciéndolo más fácil de leer. Lo que evita que los espaguetis se codifiquen, porque sabes exactamente de qué hilo estás tirando en un momento dado.
3. Comenta tu código
Los comentarios de código son quizás la forma más fácil de evitar que los repositorios se llenen de código espagueti. Cuando escribas algo, haz un comentario sobre lo que hace. Si se trata de una función complicada o un fragmento de código, explique qué hace la lógica y por qué es importante.
Sin embargo, se encuentra con un par de problemas que dependen de los comentarios del código para evitar un desastre. Primero, agrega mucho tiempo extra a los proyectos. Cuando intenta cumplir con una fecha límite o asegurarse de que una función funcione correctamente, no siempre necesita escribir una explicación detallada. Y si comienzas a comentar y abandonas a mitad del proyecto, ¿no continuará el próximo desarrollador? Es un plato grande de espagueti.
A otros les abruma la idea de comentar su código -o aprender a comentar tu código si no lo has hecho antes- por la enorme cantidad que desarrollan. Lo cual es absolutamente correcto. Pero incluso si comenta líneas o pasajes importantes (o incluso inciertos) de vez en cuando, le ahorrará a alguien, potencialmente a usted mismo, la molestia de recuperarlo en el pasado tratando de averiguar qué está haciendo.
Envase
El código espagueti es una pesadilla, repito. Pasar innumerables horas tratando de averiguar qué línea de código se ha cambiado en un repositorio gigante es una de las peores partes de ser un desarrollador. La depuración está bien (ish). La depuración y no saber por dónde empezar o lo que ni remotamente causa el problema no lo es. Pero si su equipo establece estándares de codificación, se adhiere a la guía de estilo del idioma e incluso aplica una política de comentarios de código menor, existe una gran posibilidad de que su plato de espagueti digital esté mucho menos enredado de lo que sería de otra manera.
¿Qué estás haciendo para evitar la codificación espagueti?
Artículo con una imagen de Donnay Style / shutterstock.com
