Tarea: Revisar el código
En esta tarea se describe cómo revisar el código para verificar la implementación.
Relaciones
RolesPrincipal: Adicional: Asistencia:
EntradasObligatoria: Opcional:
  • Ninguno
Externa:
  • Ninguno
Salidas
Pasos
Recomendaciones generales
Objetivo Recomendaciones generales para cada revisión.

Cuando cree software de alta calidad, la revisión de la implementación es un complemento de otros mecanismos de calidad como, por ejemplo, la compilación, la integración y las pruebas. Antes de revisar la implementación, compílela y utilice herramientas como, por ejemplo, los comprobadores de reglas de código, para capturar el máximo de errores posible. Considere la utilización de herramientas que permitan visualizar el código. También se pueden detectar y eliminar errores adicionales antes de la revisión de implementación, si el código se ejecuta utilizando herramientas de detección de errores en tiempo de ejecución.

Las ventajas de revisar la implementación son las siguientes:

  • Reforzar y promover un estilo de codificación común en el proyecto. La revisión de código es una buena forma de que los miembros sigan las directrices de programación. Para garantizarlo, lo más importante es revisar los resultados de todos los autores e implementadores, en lugar de revisar todos los archivos de código fuente.
  • Localizar errores que las pruebas automatizadas no encuentran. Las revisiones de implementación detectan errores distintos a los de las pruebas.
  • Compartir el conocimiento entre personas y transferirlo de las personas con más experiencia a las personas con menos experiencia.

Existen varias técnicas que se pueden utilizar para revisar la implementación. Utilice una de las siguientes:

  • Inspección. Una técnica de evaluación formal en la que se examina en detalle la implementación. Las inspecciones se consideran la técnica de revisión más productiva, aunque requieren formación y preparación.
  • Ensayo. Una técnica de evaluación en la que el autor de la implementación dirige a uno o varios revisores a través de la implementación. Los revisores plantean preguntas y hacen comentarios sobre la técnica, el estilo, posibles errores, la violación de los estándares de codificación, etc.
  • Lectura de código. Una o dos personas leen el código. Cuando los revisores estén listos, pueden reunirse y presentar sus comentarios y preguntas. No obstante, la reunión se puede omitir y que los revisores proporcionen sus comentarios y preguntas al autor por escrito. La lectura de código se recomienda para verificar pequeñas modificaciones y para "curarse en salud".

Los requisitos de habilidades para este rol son parecidos a los del rol: Implementador; las personas que tengan este rol se consideran normalmente expertos en el lenguaje de programación que se utiliza para el código que se está revisando. En la mayoría de proyectos, este rol se asigna utilizando programadores expertos del equipo de implementación.

Consulte también Técnica: Revisores.

Establecer puntos de control para la implementación
Objetivo Establecer una lista de comprobación para revisar la implementación.  


En este apartado se proporciona una lista de comprobación general para revisar la implementación, como ejemplos de qué se tiene que buscar en una revisión. Las directrices de programación deben ser la principal fuente de información para la calidad del código.

General

  • ¿Sigue el código las directrices de programación?
  • ¿Está el código autodocumentado? ¿Se puede entender el código al leerlo?
  • ¿Se han solucionado los errores detectados mediante la comprobación de reglas de código y/o las herramientas de detección de errores en tiempo de ejecución?

Comentarios

  • ¿Están actualizados los comentarios?
  • ¿Son correctos los comentarios? ¿Están claros?
  • ¿Se pueden cambiar fácilmente los comentarios si se modifica el código?
  • ¿Se centran los comentarios en explicar el por qué y no el cómo?
  • ¿Se han comentado todas las sorpresas, casos excepcionales y errores de método alternativo?
  • ¿Se ha comentado el objetivo de cada operación?
  • ¿Se han comentado otros hechos relevantes sobre cada operación?

Código fuente

  • ¿Tiene cada operación un nombre que describe su función?
  • ¿Tienen los parámetros nombres descriptivos?
  • ¿Se puede distinguir claramente la vía normal a través de cada operación de otras vías excepcionales?
  • ¿Es la operación demasiado larga? ¿Se puede simplificar extrayendo sentencias relacionadas en operaciones privadas?
  • ¿Es la operación demasiado larga? ¿Se puede simplificar reduciendo el número de puntos de decisión? Un punto de decisión es una sentencia en la que el código puede seguir distintas vías, por ejemplo, sentencias if-, else-, and-, while- y case.
  • ¿Se ha minimizado la anidación de bucles?
  • ¿Tienen las variables el nombre correcto?
  • ¿El código es sencillo? ¿Evita soluciones "inteligentes"?
Preparar el registro de revisión y los defectos de documentos
Objetivo Documentar los resultados de la revisión.
Garantizar que los defectos identificados estén documentados.  


Después de cada reunión de revisión, los resultados de la reunión se deben documentar en un Registro de revisión. Asimismo, los defectos se deben documentar en las Solicitudes de cambio (y asignar finalmente a un propietario que las lleve a cabo).



Propiedades
Varias apariciones
Condicionado por sucesos
Continuo
Opcional
Planeado
Se puede repetir