¿Cuál es el propósito de una revisión de código?

Estoy en el proceso de intentar vender a mi organización el valor de las revisiones de código. He trabajado en varios lugares donde estaban empleados. Los he visto acostumbrados a elegir opciones de estilo y decisiones funcionales, y los he visto como nada más que una verificación intestinal para asegurarme de que no se implemente nada peligroso. Mi intuición es que el propósito más efectivo está en algún lugar entre las dos opciones.

Entonces, ¿cuál es el propósito de una revisión de código?

Existen varias razones por las que desearía realizar una revisión del código:

• Educación de otros desarrolladores. Asegúrese de que todos vean la modificación asociada con una corrección o mejora de defectos para que puedan entender el resto del software. Esto es especialmente útil cuando las personas trabajan en componentes que necesitan integrarse o en sistemas complejos donde una persona puede pasar largos períodos sin mirar ciertos módulos.
• Encontrar defectos u oportunidades de mejora. Tanto el código entregable como el código de prueba y los datos se pueden examinar para encontrar debilidades. Esto garantiza que el código de prueba sea robusto y válido y que el diseño y la implementación sean consistentes en toda la aplicación. Si es necesario realizar cambios adicionales, aprovecha la oportunidad más cerca del punto de entrada.

Existen varios casos comerciales para realizar revisiones:

• Encontrar defectos o problemas que tendrían que modificarse más cerca de su inyección. Esto es mas barato.
• Conocimiento compartido del sistema y entrenamiento cruzado. Menos tiempo para que un desarrollador se ponga al día para realizar cambios.
• Identificación de posibles mejoras al sistema.
• Abrir la implementación para garantizar que los evaluadores brinden una cobertura adecuada. Convertir una caja negra en una caja gris o blanca desde una perspectiva de prueba.

Si está buscando una discusión exhaustiva sobre los beneficios y las estrategias de implementación para las revisiones por pares, le recomiendo que revise las revisiones por pares en software: una guía práctica de Karl Wiegers .

Las revisiones de código son una herramienta para la transferencia de conocimiento .

• Cuando los desarrolladores revisan el código de los demás, se familiarizan en todas las áreas del sistema. Esto reduce el factor de bus de un proyecto y hace que los desarrolladores sean más eficientes cuando tienen que hacer mantenimiento en una parte del sistema que no escribieron.

• Cuando un programador junior revisa el código de un senior, el programador junior puede aprender trucos, de lo contrario solo se aprende a través de la experiencia. Esto también puede funcionar como un correctivo contra código demasiado complicado.

  Una revisión exhaustiva del código requerirá verificaciones frecuentes de diversos documentos. Es una excelente manera de aprender un idioma o API.

• Cuando un programador senior revisa el código de un junior, esta es una oportunidad para resolver los problemas antes de que se traduzcan en deudas técnicas. Una revisión del código puede ser un buen escenario para guiar a los programadores junior.

Las revisiones de código no son sobre:

• ... encontrando errores. Para eso están las pruebas. Todavía ocurrirá con frecuencia que una revisión de código encuentra algún problema.

• ... quisquilloso en cuestiones de estilo: conformarse con un estilo y utilizar formateadores automáticos para imponerlo. Pero hay muchas cosas que una herramienta automatizada no puede verificar. Las revisiones de código son un buen lugar para asegurarse de que el código esté suficientemente documentado o autodocumentado.

Lo más valioso que personalmente obtengo de una revisión de código es la confianza de que el código es claro para otra persona. ¿Las variables están claramente nombradas? ¿El propósito de cada fragmento de código es razonablemente obvio? ¿Se aclara algo ambiguo con un comentario? ¿Los casos límite y los valores válidos para los parámetros se describen en los comentarios y se verifican en el código?

Me gustaría agregar dos áreas que no están cubiertas por las otras excelentes respuestas:

Una gran razón para las revisiones de código es el efecto Hawthorne, que en nuestro caso se traduce en: Si sabe que alguien va a mirar su código después, entonces es mucho más probable que lo escriba mejor en primer lugar.

Otra gran razón es para mejores prácticas de desarrollo seguras. Solo hay que mirar el error de Goto de Apple (una línea de código duplicada accidental) o el error Heartbleed (un error básico en la validación de entrada) para comprender la importancia de las revisiones de código adecuadas en un ciclo de vida de desarrollo seguro.