Aunque se han publicado varias respuestas útiles aquí por un tiempo, creo que hay espacio para una más. Mi sugerencia es, como han dicho otros, hacer revisiones de código. Pero vale la pena mencionar nuevamente porque el término "revisión de código" es muy vago ... casi tan vago como "código limpio" :-). Me he dedicado mucho tiempo y esfuerzo a trabajar para lograr ese objetivo difícil de alcanzar. Y particularmente en los últimos dos años, impulsado por colegas que compartieron mi pasión, destilé mis nociones, combinadas con ideas clave de desarrolladores prominentes, en una serie titulada Zen of Code Reviews .
Mis artículos son únicos, hasta donde yo sé, ya que cubro ambos lados del pasillo: haciendo una revisión de código como autor y haciendo una revisión de código como revisor . Aunque relacionadas, las habilidades para cada uno son algo diferentes. Y ser capaz de hacer ambas cosas bien va a llevar a una mejor calidad del código. Revisar el código es tan importante como escribir código. De Verdad. Promueve la transferencia de conocimiento, fomenta la consistencia y la comunicación del equipo, lo ayuda a mejorar su habilidad y, por último, pero no menos importante, reduce el software con errores de manera muy rentable, desde el inicio hasta el punto más posible.
Los dos primeros proporcionan consejos y técnicas para preparar una revisión de código. En una palabra:
- Usted, como autor, tiene un conocimiento íntimo de por qué cada línea modificada está en su revisión de código. Muchos son obvios para un revisor educado, pero muchos no lo son. Transmita esos puntos anotando la revisión de su código antes de enviarlo a los revisores.
- Incluso antes de eso, considere cuidadosamente lo que comprende la revisión de su código: asegúrese de incluir todos los cambios relevantes para un problema e intente no incluir más de un problema.
- Asegúrese de realizar una comprobación de control de fuente (para volver a sincronizar su código con main) antes de enviarlo.
- Revise su propio código antes de enviarlo, ¡línea por línea!
Parte 1: Comentarios previos a la revisión: capacite a sus colegas para que le den mejores comentarios sobre la revisión de su código
Parte 2: Mejores prácticas: pautas para preparar una revisión de código
Y los otros dos artículos brindan consejos prácticos sobre cómo ser un mejor revisor:
- Lea primero el Jira / issue / ticket / require (como lo llame).
- Asegúrese de que las pruebas unitarias cubran los requisitos.
- Revise las pruebas unitarias para la clase de equivalencia y la integridad del valor límite.
- Asegúrese de que cada prueba unitaria haga lo suficiente, sin probar varias cosas.
- Revise el código para cumplir con los principios de SOLID.
- Tenga cuidado con reinventar ruedas, código demasiado complicado y solo código complicado.
- Evita la magia (cuerdas mágicas, entradas mágicas y, sí, incluso booleanos mágicos).
- Capture el efecto mariposa: ¿hay ondas que se perdieron (por ejemplo, inconsistencias de nomenclatura)?
Parte 3: El cuento del revisor: pautas para realizar una revisión de código
Parte 4: Revise como si fuera el propietario del código