Las revisiones de código son importantes porque mejoran la calidad del código y hacen que su base de código sea más estable. Además, ayudan a los programadores a establecer relaciones y a trabajar juntos de forma más eficaz.
Pero revisar el código de un compañero es más fácil de decir que de hacer. Por no hablar de que dirigir un proceso de revisión puede ser una pesadilla para los jefes de equipo. Por eso, te explicamos qué hay que buscar en una revisión de código, el proceso de revisión de código y cuáles son las nueve mejores prácticas de revisión de código.
Lee a lo largo o salta a la sección que más te interese:
- Mejores prácticas de revisión de código
- Mejores prácticas de revisión de código por parte de los compañeros
- Mejores prácticas de revisión de código para cómo llevar a cabo una revisión de código
- Aplique las mejores prácticas de revisión de código con las herramientas adecuadas
- ▶️ Comience su prueba gratuita de análisis de código estático
Mejores prácticas de revisión de código
Aquí están las nueve mejores prácticas de revisión de código:
1. Sepa qué buscar en una revisión de código
2. Construya y pruebe – antes de la revisión
3. No revise el código por más de 60 minutos
4. Revise no más de 400 líneas a la vez
5. Dé comentarios que ayuden (no que perjudiquen)
6. Comunique los objetivos y las expectativas
7. Incluya a todos en el proceso de revisión del código
8. Fomente una cultura positiva
9. Automatizar para ahorrar tiempo
Mejores prácticas de revisión de código por pares
Te contamos los secretos mejor guardados de las revisiones por pares. Las revisiones por pares tienen que ver con la colaboración, no con la competencia.
Siga estas cinco mejores prácticas de revisión de código por pares.
Saber qué buscar en una revisión de código
Es importante ir a las revisiones sabiendo qué buscar. Busque cosas clave, como…
Estructura. Estilo. Lógica. Rendimiento. Cobertura de las pruebas. Diseño. Legibilidad (y mantenibilidad). Funcionalidad.
Puedes hacer comprobaciones automatizadas (por ejemplo, análisis estático) para algunas de las cosas – por ejemplo, la estructura y la lógica. Pero otras -por ejemplo, el diseño y la funcionalidad- requieren que un revisor humano las evalúe.
Revisar el código con ciertas preguntas en mente puede ayudarle a centrarse en las cosas correctas. Por ejemplo, podría evaluar el código para responder:
- ¿Entiendo lo que hace el código?
- ¿Funciona el código como espero?
- ¿Cumple este código con los requisitos normativos?
Al evaluar el código de forma crítica -con preguntas en mente- se asegurará de comprobar las cosas correctas. Y reducirás el tiempo a la hora de realizar las pruebas.
Construir y probar – Antes de la revisión del código
En la era actual de la integración continua (CI), es clave construir y probar antes de hacer una revisión manual. Lo ideal es que, una vez superadas las pruebas, realices una revisión y la despliegues en la línea de código de desarrollo.
Esto asegura la estabilidad. Y hacer primero las comprobaciones automatizadas reducirá los errores y ahorrará tiempo en el proceso de revisión.
La automatización evita que pierdas tiempo en las revisiones.
▶️ Comienza tu prueba gratuita de análisis de código estático >>>
No revise el código durante más de 60 minutos
Nunca revise durante más de 60 minutos seguidos. El rendimiento y la atención al detalle tienden a caer después de ese tiempo. Es mejor realizar revisiones a menudo (y en sesiones cortas).
Tomar un descanso le dará a tu cerebro la oportunidad de resetearse. Así, podrás revisar de nuevo con ojos frescos.
Darte tiempo para hacer revisiones cortas y frecuentes te ayudará a mejorar la calidad del código base.
Revisa no más de 400 líneas a la vez
Si intentas revisar demasiadas líneas de código a la vez, es menos probable que encuentres defectos. Intente mantener cada sesión de revisión en 400 líneas o menos. Establecer un límite de líneas de código (LOC) es importante por las mismas razones que establecer un límite de tiempo. Garantiza que estés al máximo cuando revises el código.
Centrarse en menos de 400 líneas hace que sus revisiones sean más eficaces. Y te ayuda a asegurar una mayor calidad en el código base.
Da comentarios que ayuden (no que perjudiquen)
Trata de ser constructivo en tus comentarios, en lugar de crítico. Puede hacerlo haciendo preguntas, en lugar de hacer afirmaciones. Y recuerde dar elogios junto con sus comentarios constructivos.
Dar feedback en persona (o incluso hacer tu revisión en persona) te ayudará a comunicarte con el tono adecuado.
Tu código siempre necesitará ser revisado. Y tú siempre necesitarás revisar el código de tus compañeros de trabajo. Cuando enfocas las revisiones como un proceso de aprendizaje, todos ganan.
📕 Recurso relacionado: Developer Challenge: ¿Son eficaces sus revisiones de código?
Mejores prácticas de revisión de código para saber cómo ejecutar una revisión de código
Ejecutar una revisión de código -y asegurarse de que todo ha sido revisado correctamente- puede ser un gran desafío.
Siga estas cuatro prácticas recomendadas para saber cómo ejecutar una revisión de código.
Comunicar objetivos y expectativas
Debe tener claro cuáles son los objetivos de la revisión, así como las expectativas de los revisores. Dar a sus revisores una lista de control asegurará que las revisiones sean consistentes. Los programadores evaluarán el código de los demás con los mismos criterios en mente.
Al comunicar los objetivos y las expectativas, todo el mundo ahorra tiempo. Los revisores sabrán qué buscar – y podrán utilizar su tiempo de forma inteligente en el proceso de revisión.
Incluya a todos en el proceso de revisión del código
No importa la antigüedad del programador, todos necesitan revisar y ser revisados. Al fin y al cabo, todos rinden más cuando saben que alguien más va a revisar su trabajo.
Cuando se realizan revisiones, es mejor incluir tanto a otro ingeniero como al arquitecto de software. Detectarán diferentes problemas en el código, en relación tanto con la base de código más amplia como con el diseño general del producto.
Incluir a todos en el proceso de revisión mejora la colaboración y las relaciones entre los programadores.
▶️ Comienza tu prueba gratuita de Helix Swarm >>>
Fomentar una cultura positiva
Fomentar una cultura positiva en torno a las reseñas es importante, ya que juegan un papel vital en la calidad del producto. No importa quién introdujo el error. Lo que importa es que el error se detectó antes de que entrara en el producto. Y eso hay que celebrarlo.
Al fomentar una cultura positiva, ayudarás a tu equipo a apreciar (en lugar de temer) las revisiones.
Automatizar para ahorrar tiempo
Hay algunas cosas que los revisores tendrán que comprobar en las revisiones manuales. Pero hay algunas cosas que se pueden comprobar automáticamente utilizando las herramientas adecuadas.
Los analizadores estáticos de código, por ejemplo, encuentran problemas potenciales en el código comprobándolo con las reglas de codificación. La ejecución de analizadores estáticos sobre el código minimiza el número de problemas que llegan a la fase de revisión por pares. El uso de herramientas para revisiones ligeras también puede ayudar.
Al utilizar herramientas automatizadas, se puede ahorrar tiempo en el proceso de revisión por pares. Esto libera a los revisores para que se centren en los problemas que las herramientas no pueden encontrar, como la usabilidad.
📕 Contenido relacionado: Cómo hacer revisiones de código
Aplica las mejores prácticas de revisión de código con las herramientas adecuadas
Si quieres aplicar las mejores prácticas de revisión de código, necesitarás las mejores herramientas.
Una mejor revisión de código comienza con las herramientas de Perforce
Perforce tiene herramientas para mejorar su proceso de revisión de principio a fin.
Cómo los analizadores estáticos de Perforce mejoran las revisiones de código desde el principio
Los analizadores estáticos de Perforce – Helix QAC para C/C++ y Klocwork para C, C++, C# y Java – pueden utilizarse para analizar el código y eliminar los errores de codificación antes de que el código llegue a la fase de revisión por pares.
Ambos se aseguran de que su código cumple con las reglas de codificación. Y destaca y prioriza los problemas que deben ser corregidos, para que los programadores puedan ser más eficientes en el proceso de revisión.
Los revisores pueden añadir sus anotaciones en el código fuente, junto con los mensajes de diagnóstico de Perforce Static Analyzers. Y los programadores reciben notificaciones cuando los analizadores estáticos encuentran problemas relacionados con su parte del código.
Cómo Helix Swarm facilita la colaboración
Helix Swarm es una herramienta de revisión de código basada en la web que se incluye con Helix Core. Puedes utilizarla para escalar las revisiones a medida que tu equipo crece y mejorar la colaboración durante el proceso.
Helix Swarm facilita la ejecución de las revisiones automatizando el proceso. Los equipos pueden utilizar esta herramienta para supervisar el progreso y ver cuáles se han completado – y cuáles están todavía en curso.
Los revisores reciben notificaciones automáticas sobre sus tareas y un panel de control de sus elementos de acción. Además, todos pueden colaborar fácilmente manteniendo conversaciones directamente en el código. Compruebe por sí mismo cómo Helix Swarm le ayudará.
▶️ Vea una demostración de Helix Swarm
Afirme las mejores prácticas de revisión de código con el análisis estático
Los analizadores de código estático de Perforce -Helix QAC y Klocwork- y Helix Swarm se integran con Jenkins y otros ejecutores de construcción. Por lo tanto, puede ejecutar compilaciones y pruebas antes de sus ciclos de revisión por pares.
El uso de las herramientas de revisión de código de Perforce elimina el tiempo de espera y le ayuda a colaborar mejor durante todo el proceso. Compruebe usted mismo cómo le ayudarán los analizadores estáticos de Perforce.
▶️ prueba gratuita de análisis de código estático