디자인 및 코드 검토 수행 지침
다음 지침에서는 디자인 및 코드 검토를 위한 여러 가지 기술에 대해 설명합니다.
필수
검토할 시간을 갖습니다.
검토를 수행하는 목적은 디자인과 코드를 잘 이해하고 분석하기 위해서입니다. 코드를 작성하거나 처음에 디자인을 계획했던 시간의 절반 정도를 검토에 할애하십시오.
검토자가 검토를 주도합니다.
검토자와 검토자의 의견에 따라 검토를 진행해야 합니다. 개발자가 자신의 작업에 대한 검토를 주도하면 다른 검토자들이 문제를 놓칠 수 있습니다.
검토 회의를 갖기 전에 코드나 디자인 문서를 읽어 봅니다.
극히 사소한 변경 내용을 검토하기 위한 회의가 아니라면 검토 회의에 앞서 준비가 필요합니다. 검토자가 코드나 디자인을 읽어 검토 회의를 미리 준비하지 않으면 관련자 모두의 시간을 낭비하게 됩니다.
그룹 검토에 Team Project Portal을 사용합니다.
모두가 쉽게 찾아 검토할 수 있는 프로젝트 포털에 디자인 문서를 게시합니다. Internet Explorer 토론 기능을 사용하여 게시된 문서에 대한 포인터를 검토자에게 보내고 의견을 추가하도록 요청합니다. 코드도 이와 비슷한 방식으로 검토하려면 코드를 Word 문서에 붙여넣고 SharePoint 사이트에도 게시합니다. 자세한 내용은 프로젝트 계획 및 추적을 참조하십시오.
검사 목록을 사용합니다.
보안, 오류 처리 또는 스타일에 중점을 두는 경우처럼 특정한 측면을 검토하면 작업이 쉬워집니다. 한 가지 측면에 대한 검토가 끝난 후에는 다른 작업으로 넘어갈 수도 있습니다. 검사 목록을 사용하면 검토에서 다뤄야 하는 여러 가지 다른 측면을 기억할 수 있습니다.
코드 검토에서 발견한 모든 문제를 추적합니다.
문제를 작업 항목, 코드의 주석 또는 디자인 문서의 문제로 문서화합니다. 그렇지 않으면 문제를 놓칠 수 있으며 코드 검토를 수행하는 동안 아무런 결과도 얻지 못하게 됩니다. 자세한 내용은 작업 항목 만들기를 참조하십시오.
금지 사항
검토자에게 알리지 않고 코드나 디자인을 변경합니다.
검토를 위해 검토자에게 디자인이나 코드를 보낸 후에 오류를 발견할 경우 검토 회의를 갖기 전에 문제를 수정하면 안 됩니다. 회의 전에 코드나 디자인을 변경하면 검토에 혼란을 초래하여 검토자에게 방해가 될 수 있습니다. 대신 발견한 실수를 기록하고 다른 모든 검토 메모와 함께 추적하여 검토자 입장에서 처리하십시오.
권장
모든 분야의 담당자를 참여시킵니다.
개발 외에 여러 분야의 사람들을 디자인 및 코드 검토에 참여시켜는 것이 항상 바람직한 것은 아니지만 발견하기 어려운 문제를 찾아내는 데 도움이 될 수 있습니다. 분야별로 한두 명이면 충분합니다. 사람이 많아지면 검토 과정이 길어지고 관리하기가 어렵습니다.
모든 코드와 디자인을 검토합니다.
제품의 품질을 높이려면 모든 작업의 코드와 디자인을 검토하십시오. 코드 분석, 단위 테스트 및 초기의 디자인 문서화 작업을 검토에 포함해야 합니다.
보류 집합을 만들어 코드 검토를 관리하는 것이 좋습니다.
검토자가 검사하도록 할 변경 내용만 포함된 보류 집합을 만들 수 있습니다. 보류 집합을 만들면 변경 내용을 버전 제어에 체크 인하지 않고도 검토자와 공유할 수 있습니다. 자세한 내용은 보류 집합 사용을 참조하십시오.