🕊️ 코드리뷰에 관하여

코드리뷰는 한 명 이상의 사람이 작성된 코드를 적용하기 전에 검토하는 것을 뜻합니다. 가장 주된 목적은 역시 버그를 방지하는 것입니다. 그 뿐만 아니라, 코드리뷰는 코드의 퀄리티를 향상시키는 등 많은 장점이 있습니다. 이번에는 '코드 리뷰'에 관한 글을 가져왔습니다. 📌 코드 리뷰에는 어떤 장점이 있을까? - 버그를 줄인다. - 보안을 향상시킨다. - 시간과 돈을 절약한다. - 성능을 향상시킨다. - 코딩 표준에 도달한다. - 팀 동료들 간에 지식을 공유한다. - 서로 간에 신뢰를 얻을 수 있다. 📌 코드 리뷰는 어떻게 하는 걸까? "나를 위한 코드리뷰 체크리스트를 작성하자!" 코드리뷰 체크리스트가 있다면, 일반적인 실수가 다시 일어나지 않도록 방지할 수 있습니다. 또한 코드를 작성하는 사람과 검토하는 사람 둘 모두에게 도움을 제공합니다. 코드리뷰 체크리스트 항목은 언어, 프로젝트 및 팀에 따라 달라질 수 있습니다. 다음 항목들은 공통적인 체크리스트 사항을 요약한 것입니다. ✔ PR에서 충돌이 없는가? ✔ 새로 작성된 코드의 아키텍처를 확인하라. ✔ 네이밍이 명확한가? ✔ Bool 값의 네이밍이 is, can, must, will... 로 시작하는가? ✔ 적절한 설명이 있는가? 불필요한 주석은 없는가? ✔ 코드를 주석처리 하지 말고 삭제하라. ✔ 불필요한 메서드, 변수가 삭제되었는가? ✔ 불필요한 스페이스를 제거하였는가? ✔ "print" 문이 없는가? ✔ 변수 혹은 메서드가 public인지 private인지 확인하였는가? ✔ "final" 클래스는 조심해서 사용하라. ✔ "+" 대신 string concat을 사용하라. ✔ == nil 대신 isEmpty를 사용하라. ✔ == false 대신 !를 사용하라. ✔ 모든 경우의 에러가 다루어지는가? ✔ 코드 설명 문서를 작성하라. 검토자 또한 검토한 코드에 대한 책임이 있습니다. 그러나 이것을 악용하여 작성자와 검토자가 서로에게 코드를 떠넘기는 일은 하지 맙시다. 🐣 처음엔 어색할지 몰라도, 익숙해진다면 코딩 실력을 향상시키는 지름길입니다.