Thread by @baumannzone

🤔¿Cómo interrogar a un #código que no es tuyo?

Como #developer, no siempre trabajas con fácil de leer y entender desde el primer momento.

🔧 Por eso te traigo 10 TRUCOS que puedes usar para interrogar el código desconocido.

[ HILO ] ↓

1. Instala plugins. Suena obvio, pero tal vez no estés exprimiendo al máximo tu editor de código.

✅ Instala cosas como: Resaltado de sintaxis, auto formateo, refactoring, navegación contextual (ver implementación, ver referencia, etc), test-runners, ...

2. Lee el código al menos dos veces.

A la pimera casi nunca es suficiente para entender completamente lo que hace un trozo de código. Dos debería ser el mínimo.
🦆 Si tienes un patito de goma, es el momento de empezar a hablar con él.

3. Refactoriza funciones y variables locales. 🥴
A veces una función es tan confusa que es difícil de razonar qué hace.
Un truco es renombrar las variables locales y los métodos privados para describir con mayor precisión lo que hacen.

4.0. Observa cómo se utiliza el código 🔎
Casi todo tu código es utilizado por más código. Si te atascas con un trozo de código pero entiendes dónde se utiliza, eso te puede dar contexto para averiguar lo que está haciendo.

4.1. Lo suyo sería que tu IDE te deje hacer clic con el botón derecho del ratón en el método y seleccionar "Ver referencias" (A no ser que programes con el bloc de notas 😔).
Esto te dirá todos los lugares donde se utiliza el método y así entender el contexto mejor.

4.2. Si tu editor no tiene esa funcionalidad, otro TRUCAZO es renombrar la función a algo absudro tipo `PizzaConPiña`. 🍍
Los errores te dirán dónde se estaba utilizando el método. Luego no te olvides de renombrar el método.

5. Busca código similar
A veces, el código es difícil de entender aunque esté todo con buenas prácticas y bien nombrado.

🕵️‍♀️ Domina la búsqueda global. cmd + shift + F: palabra completa, solo un trozo de la palabra, con mayus/minus. Y lo más potente... expresiones regulares!

6. Ejecuta pruebas unitarias ✅
En el caso ideal, los test unitarios es lo único que necesitarías para entender cómo funciona un trozo de código.
Sin embargo, no siempre te van a ayudar, porque no cubran todos los casos o porque estén obsoletos. pero seguro q te sirven de algo.

7. Usa el debugger
Pon un punto de interrupción y ejecuta los test. Cuando llegues al punto de interrupción, la ejecución se detendrá y podrás ir (literalmente 👣) paso a paso, entrar y salir de las funciones, e ver los valores de todas las variables en el scope.

8. Busca en la "base de conocimientos"
Si usais herramientas como Confluence, una wiki o Stack Overflow for Teams deberías ir ahí y leerte la documentación. Lo más probable es que esté obsoleta, pero te podría dar pistas de cómo funciona lo que tu necesitas.

9. Usar "git blame"
No me gusta que este comando se llame así, blame. No se trata de señalar o juzgar a nadie.
Este comando te dirá que persona hizo qué commit por cada línea de código. Siempre es bueno saber esto para así poder preguntar o buscar contexto.

10. Usa herramientas de auto-documentación
Cada lenguaje tiene su herramienta. En #JavaScript puedes usar JsDoc. Documenta tu código siguiendo unas directrices a lo largo de todo el proyecto. Genera documentación de tus funciones de manera rápida y consistente.

11. ¿Qué añadirías tú?
¿Qué usas habitualmente para entender mejor código legacy o código de otras personas?

¡Deja tus comentarios y opiniones! 💭

☑️ La capacidad de leer y entender código de forma eficaz es un arma secreta que llevará al siguiente nivel en las entrevistas técnicas y te convertirá en un miembro core de cualquier equipo.

☑️ Los #developers que son buenos escribiendo código son valiosos, pero los que son buenos leyendo código son aún más valiosos.

🤗 Muchas gracias por tu apoyo. No te olvides de dejar tu LIKE. 💚

¡Esto es todo! (uff, este hilo ha sido duro 🥵)

Si te gustó este hilo:

1. Sígueme en @baumannzone para más contenido como este.
2. Dale RT al primer tweet para compartirlo con tu audiencia.