La revisión de código (Code Review) es una técnica muy utilizada para mejorar la calidad del código y que los desarrolladores mejoren sus habilidades a través del aprendizaje y discusión de problemas.

¿Alguna vez hiciste una revisión de código? ¡Te invitamos a que conozcas algunos tips para hacer las mejores revisiones!

 

No es una crítica al autor

Antes de realizar la revisión, tanto vos como tus compañeros recuerden que es un evento de aprendizaje. Hacemos la revisión para adquirir nuevas herramientas, reflexionar sobre lo que hicimos, y por lo tanto crecer como desarrolladores.

En todo caso, estamos para hacerle una crítica constructiva al código. El problema es que tendemos a identificarnos con "nuestras" ideas (y mucho más de "nuestro" trabajo) y llegamos a pensar que si algo anda mal con nuestro código, algo anda mal con nosotros.

Creer que no nos podemos equivocar nos limita a la hora de aprender cosas nuevas.

 

Mirá el código con el desarrollador

Acordate que podés hacerle una oferta a los autores del código para realizar la revisión en forma conjunta. ¿Qué mejor que sacarte todas las dudas al preciso instante? No solamente por si no entendés alguna línea o porción puntual, sino que también es otra forma de eliminar supuestos, así como ver y entender cosas que probablemente no se ven a simple vista.

¿Por qué existe esta clase?

¿Qué necesidad tenía el cliente atrás de esto?

¿Qué responsabilidad tiene exactamente este método?

¡Y muchas preguntas más!

 

Definí el alcance de tu revisión

No te olvides de definirlo apenas empezás. Es recomendable que planifiques qué vas a mirar y sobre qué vas a dar feedback, ya que cuando un proyecto es grande hay muchísimas cosas para revisar y de las que podemos aprender algo.

¿Reviso sólo la capa de negocio?

¿Reviso el diagrama de diseño? ¿Cómo es el dominio?

¿Qué hay de los tests?

Empezá por algún lugar y fijate hasta dónde querés llegar. ¡Así vas a poder hacer un análisis enfocado y aprovechar mejor el tiempo!

 

¿Qué hay de mi API Rest?

Si, por ejemplo, decidiste hacer la review del API Rest, es recomendable que listes en una misma hoja todos los endpoints (método http y url de cada uno) que quieras analizar.

¿Qué tan coherente es el verbo http con la acción que realiza?

¿Cómo se están identificando los recursos en la URL?

¿Qué tanto puedo intuir lo que hace ese servicio al ver el endpoint?

¡Nada mejor que un API que se documenta a sí misma!

 

El diseño en primer lugar

El código que estás revisando parte (o debería partir) de un diseño previo. Está bueno que chequees que el código que estás revisando se corresponda con este. Es común que desarrollemos sobre funcionalidad ya existente y que en el proceso los diagramas queden desactualizados.

Por otro lado, ver el diseño te permite observar con un mayor nivel de abstracción cómo se compone el sistema en su totalidad, y eso abre el panorama a detectar mejoras en la arquitectura.

¡Un código consistente con un buen diseño es mantenible y fácil de entender!

 

Bonus: ¿Cómo lo podemos mejorar?

Es probable que mientras estabas revisando el proyecto se te hayan ocurrido un montón de cosas para hacer y mejorar. Anotalas y sumalas en tu feedback. La revisión de código se trata de aprender y aportar mayor calidad al código que desarrollamos como equipo. Una pequeña revisión puede generar un gran aporte.

¡Te dejamos también un video resumen con los tips!

Si te gustó, compartilo por tus redes y contanos qué te pareció esta técnica de Code Review.