코드 품질 개선 기법 25편: 요컨대... 무슨 말이죠?

LY Corporation의 코드 품질 개선 노력

• LY Corporation은 높은 개발 생산성을 위해 코드 품질 및 개발 문화 개선에 힘쓰고 있습니다.
• Review Committee 활동을 통해 머지된 코드를 리뷰하고, 얻은 지식과 인사이트를 Weekly Report로 공유합니다.
• 이 Weekly Report 중 널리 적용 가능한 주제를 선정하여 코드 품질 개선 기법 시리즈를 연재합니다. 비효율적인 코드 리뷰 코멘트와 개선 방안
• UserModel의 var 속성에 대한 리뷰에서, 리뷰어는 가변 객체 공유의 위험성과 불변 객체 사용의 중요성을 지적했습니다.
• 또한, 값의 라이프사이클에 따라 UserModel과 UserStatus로 클래스를 분리하는 것을 제안했습니다.
• 원래 코멘트는 이유를 먼저 설명하여 이해하기 어려웠으나, 개선된 코멘트는 제안/요청 사항을 먼저 제시하고 그 이유를 구조화하여 설명합니다. 효과적인 리뷰 코멘트 작성 원칙
• 제안/요청 사항을 먼저 제시하여 리뷰 요청자가 핵심을 빠르게 파악하도록 돕습니다.
• 이유는 객체의 불변성과 값의 라이프사이클 측면에서 명확히 설명하며, 항목별 제목을 붙여 가독성을 높입니다.
• 이러한 방식은 커뮤니케이션 효율을 높이고, 불필요한 재독을 줄여줍니다.