본문 바로가기

IT/Programming

코드 리뷰의 목적

목적 : 코드를 만든 사람 혼자에게 있지 않고 우리 모두에게 있다는 문화를 만드는 데에 있다.

장점 : 

  1. 버그의 조기 발견
  2. 개발 표준(convention) 준수
  3. 중복 코드를 방지하고 모듈의 재사용성 증대
  4. 다른 사람의 잘 만들어진 코드를 보면서 배울 기회를 얻음

 

 

 

 

코드 리뷰 종류 : 

1. 온라인 코드 리뷰

  • 도구를 이용하여 온라인상에서 진행하는 방식
  • 대표적인 코드리뷰 도구 : Crucible, GitLab, Phabricator, Rhodecode
  • 과정 : 코드의 작성자가 변경사항에 대한 코드리뷰를 요청 → 리뷰어들은 해당 코드의 피드백을 작성 → 코드 수정이 필요하다면 코드 작성자는 수정 사항들을 반영 → 리뷰어들은 코드의 최종 확인을 완료

 

GitHub 온라인 코드 리뷰 예시 

  • github의 경우 리뷰어가 해당 코드를 머지(merge)할 수 있는 권한이 있다면 최종 확인 후 코드를 머지하거나, 해당 코드가 최종적으로 확인되었음을 메시지로 표시
  • 엄지손가락(thumbsup) 이모티콘을 이용해서 최종 확인 완료를 표시

 

 

 

2. 팀리뷰

  • 오프라인에서 진행하는 방식
  • 특정한 기준을 미리 정해두고 형식에 맞춘 회의가 되어서는  되고, 조직의 특성과 상황에 맞게 고유한  리뷰 방식을 정해나가는 것이 좋다.

 

확인 항목 : 

  1. 기능의 정상 동작 여부
  2. 버그의 조기 발견
  3. 가독성
  4. 유지보수 편의성
  5. 개발 표준의 준수 여부
  6. 모듈 중복 개발