코드 리뷰

1. 개요

2. 누구의 코드를 리뷰하는가

3. 코드 리뷰 코멘트

4. 코드 리뷰의 에티켓

• 코드 내용만 비판하라. 코드를 짠 사람을 비판하지 말라: 죄는 미워하되 사람은 미워하지 말라와 비슷하다. 예를 들어 의도치 않은 무한 루프가 있는 코드가 발견되면, "여기서 무한 루프가 발생합니다." 이렇게까지만 적자. 괜히 쓸데없이 "너무 실수를 자주 하시는 것 같습니다."라던지 "커밋을 하기 전에 자가 코드리뷰를 한번 더 해보셨으면 좋았을텐데 말입니다." 같은 오지랖을 펼치지 말자. 심지어 직속 상사라 하더라도.
• 개인 취향은 코드 리뷰 대상이 아니다: 변수 이름, 함수 이름, 조건문 형태 등은 사람마다 다르게 코딩하게 된다. 프로그래머는 개인 성향이 강한 직업이 되기도 하다 보니, 더욱 이러한 특징이 나타나게 된다. 따라서 본인이 짠 코드와 타인이 짠 코드의 스타일이나 코딩 성향이 다르다 하더라도, 즉 개인 취향이 다르다 하더라도, 이를 타인에게 강요하는 것은 바람직하지 못하다. 다만, 다음은 예외적으로 코드 리뷰 대상이 된다.
• 팀 내에 정해진 코딩 스타일을 거스르는 코드
• 오타나 문법에 맞지 않는 변수, 함수이름
• 가독성을 심하게 저하시키는 코드
• 이해가 잘 되지 않는 코드는 리뷰 대상이다: 내가 누군가의 코드를 잘 읽을 수 있다면, 그것은 코드 읽는 내 실력이 뛰어난 것이 아니라, 그 코드를 짠 사람의 실력이 뛰어난 것임을 잊지 말자. 이해가 잘 되지 않는 코드라면, 코멘트를 남겨서, 당사자가 코드를 알아보기 쉽게 코드를 더 개선하거나 주석 설명을 달게 유도하는 것이 좋다. 다만, 남들은 다 이해하는데 나만 이해하지 못하는 코드였다면 창피할 수 있으며, 이런 코멘트는 "전반적인 코드 퀄리티가 떨어진다" 라는 뜻으로 전해질 수 있으므로 꼼꼼하게 읽어보고 다른 팀원들에게 가볍게 물어보거나 한 뒤에, 어떤 부분이 이해를 어렵게 하는지 개략적으로 파악하여 남기자.
• 필요한 코드리뷰만 하라: 코드 리뷰의 본연의 목적은, 더 나은 품질의 코드를 유지하는 것임을 잊지 말자. 코드의 품질을 올리는데 전혀 도움되지 못하는데도 불구하고, 그냥 자기가 봤을 때 고쳐야 한다고 생각된다는 이유로 불필요한 코멘트를 남기는 것은 적절하지 못하다. 특히 똥군기 잡는답시고 지나친 코드리뷰 코멘트를 남발하는 상사가 되지는 말자. 또한, 코멘트를 하나도 안 남기면 대충 봤다고 생각할까봐 억지로 수정점을 찾지 말고 "수고하셨습니다", "LGTM(Looks Good To Me)" 등의 한 마디와 함께 Approve 하는 게 좋다.

5. 효과

6. 관련 문서

7. 관련 링크