코드리뷰란? 코드리뷰 방법과 필수 내용

기업소개 소식 레터・영상

코드리뷰란? 코드리뷰 방법과 필수 내용

[2022-05-04]#01 - 씨앤에이아이 레터 / 개발2팀 개발문화

코드리뷰란?

코드 검토(code review)는 코드를 개발자가 작성하고, 다른 개발자 한명 또는 여러명이 정해진 방법을 통해 검토하고, 피드백을 주는 과정을 말합니다.

네이버, 카카오, 많은 스타트업에서 코드리뷰를 진행하는데, 씨앤에이아이 DX플랫폼 사업부 개발 2팀은 google, w3school 등 에서 reference하고 (google 코드리뷰 가이드)를 활용해서 리뷰 요청과 검토를 완료(Approve)하는 방식으로 코드 리뷰를 진행하고 있습니다.

코드리뷰 가이드

설계

- 코드가 잘 설계 되어있으며, 시스템에 적합한가?

기능

- 코드가 작성자가 의도한 대로 동작하는가?
- 사용자에게 좋은 방식으로 작동하는가?

복잡성

- 더 간단한 코드로 만들 수 있는가?
- 다른 개발자가 나중에 이 코드를 접했을 때 이 코드를 쉽게 이해하고 사용할 수 있는가?

테스트

- 코드에 정확하고 잘 설계된 자동화 테스트가 있는가?

네이밍

- 개발자가 변수, 클래스, 메소드 등에 대해 명확한 이름을 선택했는가?

주석