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

Context

코드 리뷰 코멘트가 장황한 설명을 먼저 제시한 후 제안을 뒤늦게 전달하면, 리뷰 요청자가 주요 포인트를 파악하기 어렵고 여러 번 재독해해야 한다.

Technical Solution

• 리뷰 코멘트 구조 변경: 구체적인 제안이나 요청 사항을 첫 문단에 배치하고 그 이유는 이후에 기술
• 이유 설명의 계층화: 항목 개수를 명시하고 각 항목에 제목을 붙여 구조를 명확하게 제시
• 사례 적용: UserModel 클래스의 var 속성을 val로 변경하고 자주 변경되는 속성을 분리하는 구체적 개선안을 먼저 제시
• 이유 제시: 객체의 불변성 보장과 속성별 라이프사이클 차이 관리라는 2가지 근거를 구조화하여 설명

Key Takeaway

코드 리뷰 코멘트에서 '무엇을 어떻게 바꿀 것인가'를 먼저 명확히 전달한 후 그 근거를 제시하면, 리뷰 요청자의 이해도가 높아지고 불필요한 재검토 비용이 감소한다.