코드 검토는 소프트웨어 개발자 또는 아키텍트가 코드를 검토하는 프로세스를 자동화하는 규칙 세트입니다. 수동 코드 검토 프로세스가 시간 소모적이며 토론에 의해 이루어지는 반면 자동 코드 검토는 효율적이고 신속하며 일관성이 있습니다. 자동 코드 검토는 수동 코드 검토를 보완합니다. 자동 코드 검토가 수동 코드 검토를 대체하지는 않습니다.
자동 코드 검토 툴은 다음 타스크를 수행하여 다양한 방식으로 소프트웨어 개발 프로세스에 장점을 제공합니다.
자동화된 프로세스는 빠르기 때문에 코드 검토를 자주 실행할 수 있습니다. 코드 검토 결과는 변경사항을 수행하기에 쉽고 적은 비용으로 문제점을 미리 발견하고 정정할 수 있게 해줍니다.
이 자습서에서는 몇 가지 코드 검토를 제공합니다. 각 코드 검토는 폴더로 구성된 여러 가지 규칙 세트를 적용합니다. 개발 프로세스 단계 및 검토 목적에 따라 사용자 요구사항에 맞는 코드 검토를 선택할 수 있습니다. 가장 자세한 검토는 다음 화면 캡처에서와 같이 모든 카테고리의 규칙에 적용되는 전체 코드 검토입니다.
일부 카테고리는 또한 연관된 코드 검토를 갖고 있습니다. 예를 들어 아래의 다음 화면 캡처에서와 같이 해당 카테고리에만 규칙을 적용하려고 할 때는 J2SE 베스트 프랙티스 코드 검토를 선택할 수 있습니다. 이것은 특정 코드 부분에 집중하여 코드 검토를 실행할 수 있게 합니다.
사용자는 마법사를 사용하여 규칙을 작성할 수 있고 두 가지 유형의 규칙(구조적 제어 및 일반) 중에서 선택할 수 있습니다. 이러한 규칙으로 소프트웨어 아키텍트는 설계 무결성을 확인하는 규칙을 작성하여 코드 검토 성능을 확장할 수 있습니다.
각 규칙에는 심각도 레벨이 있습니다. 제공되는 규칙에 대해 지정된 심각도 레벨을 수정할 수 있습니다. 마법사에서 규칙을 작성할 때 심각도 레벨을 지정합니다. 세 가지 심각도 레벨은 다음과 같은 아이콘으로 표시됩니다.
"권장사항"은 가장 낮은 심각도 레벨이지만 이러한 결과도 바로 처리하는 것이 좋습니다. 위와 같은 심각도 레벨은 엔지니어링 팀이 준수해야 하는 베스트 프랙티스 및 업계 표준 세트를 반영합니다. 이러한 결과는 긴급한 문제는 아니지만, 향후 문제가 될 수 있습니다.
다음 화면 캡처는 J2SE 베스트 프랙티스 코드 검토의 비교 폴더에 있는 규칙을 표시합니다. 폴더의 규칙은 모두 세 가지 심각도 레벨을 갖습니다.
일부 결과는 빠른 수정(제공되는 자동화 솔루션)과 함께 제공됩니다. 코드 검토의 결과에 빠른 수정이 있는 경우 다음 그림의 아이콘 중 하나로 표시됩니다.
소프트웨어 개발 라이프사이클에서 코드 검토는 코드 본문의 피어 검토 프로세스를 자동화합니다. 제공되는 코드 검토를 사용하여 다음과 같은 유형의 검토를 실행할 수 있습니다.
또한 제공되는 마법사를 사용하여 사용자 어플리케이션 설계 구조의 무결성을 확인하는 사용자 자신의 특정 규칙을 작성할 수도 있습니다.
자동 코드 검토는 빠르게 실행할 수 있기 때문에 코드 베이스의 문제점과 불일치를 미리 발견할 수 있습니다. 결과적으로 이러한 문제점이 사용자 어플리케이션의 유지보수, 확장성 및 성능에 영향을 미치기 전에 수정할 수 있습니다.
이제 연습 1.1: 필요한 자원 가져오기를 시작할 준비가 되었습니다.