Instrucciones para realizar revisiones de diseño y de código
Las instrucciones siguientes proporcionan varias técnicas para las revisiones de diseño y de código.
Se requiere
Dedique el tiempo necesario para realizar la revisión.
El propósito de la revisión es entender y analizar con atención el diseño y el código. Debe dedicar a la revisión la mitad del tiempo que ha tardado en escribir el código o en planear el diseño originalmente.
Permita que los revisores controlen la revisión.
Los revisores y sus comentarios deben controlar la revisión. Si se permite que los desarrolladores dirijan las revisiones de su propio trabajo, los demás revisores podrían pasar por alto problemas.
Lea el código o el documento de diseño antes de la reunión de revisión.
A menos que la reunión esté prevista para revisar cambios de carácter secundario, prepare de antemano las reuniones de revisión. Las reuniones de revisión en las que los revisores no se han preparado antes leyendo el código o el diseño, constituyen una pérdida de tiempo para todos los asistentes.
Utilice el portal de proyectos de equipo para las revisiones en grupo.
Publique sus documentos de diseño en un portal de proyecto donde todos los puedan encontrar y revisar con facilidad. Envíe un puntero al documento publicado a sus revisores y pídales que agreguen sus comentarios mediante la característica de discusión de Internet Explorer. Si desea que el código se revise de forma parecida, péguelo en un documento de Word y publíquelo también en un sitio Web de SharePoint. Para obtener más información, vea Planear y seguir proyectos.
Utilice una lista de comprobación.
Es fácil dejarse llevar por determinados aspectos de una revisión, por ejemplo, centrarse exclusivamente en la seguridad, el control de errores o el estilo. Podría verse tentado a pasar a otras tareas después de haber completado un solo aspecto. Las listas de comprobación le recuerdan los numerosos aspectos diferentes que debe abarcar en su revisión.
Realice el seguimiento de todos los problemas encontrados durante las revisiones del código.
Documente los problemas como elementos de trabajo, como comentarios en el código, o como problemas en los documentos de diseño. De lo contrario, los problemas se pueden perder y no habrá sacado ningún provecho del tiempo invertido en una revisión del código. Para obtener más información, vea Crear un elemento de trabajo.
Se debe evitar
Cambiar el código o el diseño sin informar a los revisores.
Aunque encuentre defectos en el diseño o el código después de que lo hayan revisado, debe resistirse a la tentación de corregir los problemas antes de la reunión de revisión. Si cambia el código o el diseño antes de la reunión, la revisión resultará confusa y es probable que los revisores se molesten por ello. En lugar de ello, trate los errores que encuentre como si fuese el revisor, anótelos y contrólelos junto con todos los demás comentarios de revisión.
Se recomienda
Incluya a representantes de todas las disciplinas.
Aunque no siempre es viable contar con distintas disciplinas además de la de desarrollo, en la revisión de los diseños y el código resulta útil contar con representantes de distintos ámbitos que le ayuden a detectar problemas difíciles de descubrir. Basta con una persona por disciplina, o quizás dos. Implicar a más personas hace que las revisiones sean largas y difíciles de administrar.
Revise todo el código y los diseños.
Para lograr calidad en su producto, se debe revisar el código y el diseño de todo el trabajo. Las revisiones deben incluir análisis de código, pruebas unitarias y documentación del diseño y de los resultados.
Considere la creación de conjuntos de cambios aplazados para administrar las revisiones del código.
Puede crear un conjunto de cambios aplazados que contengan solo los cambios que desea que los revisores examinen. Al crear un conjunto de cambios aplazados, comparte los cambios con los revisores sin protegerlos con el control de versiones. Para obtener más información, vea Trabajar con conjuntos de cambios aplazados.
Vea también
Conceptos
Analizar la calidad de la aplicación mediante herramientas de análisis del código
Mejorar la calidad del código con directivas de protección de equipo