본문 바로가기
개발이야기

코드 리뷰를 잘하기 위한 방법 5가지

by ictlab 2023. 3. 30.

코드 리뷰는 팀 내에서 품질 관리를 위해 매우 중요한 작업입니다. 코드 리뷰를 효율적으로 수행하려면 다음과 같은 방법을 고려해 볼 수 있습니다.

  1. 목적과 범위 설정 코드 리뷰를 수행하기 전에 리뷰의 목적과 범위를 명확히 설정해야 합니다. 리뷰의 목적은 품질 개선, 버그 및 보안 결함 발견, 가독성 및 유지보수성 향상 등이 될 수 있습니다. 또한 리뷰 범위는 파일, 모듈, 클래스, 함수 등의 세부 단위에서 전체 코드베이스까지 다양하게 설정할 수 있습니다.
  2. 시간 분배 코드 리뷰를 수행하기 전에 리뷰어가 리뷰에 소요되는 시간을 예상하고 분배해야 합니다. 대략적인 코드량과 리뷰 범위를 고려하여 작업 일정을 조정하고 리뷰 작업을 계획합니다.
  3. 코드 검사 도구 활용 코드 검사 도구를 활용하여 코드의 품질을 개선하고 리뷰의 효율성을 높일 수 있습니다. 코드 검사 도구는 불필요한 코드, 코딩 규칙 위반, 보안 문제, 성능 문제 등을 식별하고 리뷰어가 확인할 수 있도록 합니다.
  4. 문제 제기와 해결 리뷰어는 발견한 문제를 명확하게 기술하고, 문제 해결을 위한 대안을 제시해야 합니다. 리뷰어는 코드 작성자와 상호작용하여 발견한 문제를 해결하고 리뷰어의 의견에 대해 응답해야 합니다.
  5. 문서화와 기록 리뷰어는 리뷰를 수행하는 과정에서 발견한 문제와 해결 방안, 결정 사항 등을 문서화하고, 기록해야 합니다. 문서화된 리뷰 내용은 향후 유지보수를 위해 유용하게 사용될 수 있습니다.

이러한 방법을 통해 코드 리뷰를 효율적으로 수행할 수 있으며, 팀 내의 코드 품질을 개선하고, 생산성을 높일 수 있습니다.

 

 

https://www.mobiinside.co.kr/2016/09/23/source-code/