가독성은 코드 줄 수를 줄이는 경쟁이 아닙니다. 처음 보는 사람이 입력, 처리, 결과와 오류 경로를 따라갈 수 있는지가 기준입니다. 기존 코드 한 부분을 골라 개선 전후를 비교해 보세요.
이름과 구조
값의 역할을 드러내는 이름을 쓰고 함수가 한 수준의 일을 하도록 분리하세요. 주석이 코드와 다른 설명을 한다면 먼저 코드와 주석을 맞춥니다. Python 프로젝트라면 PEP 8의 이름과 배치 지침을 참고하되 저장소의 일관성도 고려합니다.
분기와 오류
복잡한 조건은 의미 있는 함수나 변수로 나누고, 오류가 발생했을 때 필요한 정보를 남기세요. 예외를 무조건 무시하면 문제를 발견하기 어렵습니다. 반환값이 어떤 상태를 뜻하는지도 문서화합니다.
테스트와 리뷰
리팩터링 전에 정상·경계 입력의 테스트를 만들고 변경 후 다시 실행합니다. 리뷰에서는 ‘더 깔끔하다’보다 어떤 오해를 줄였는지 설명하세요. 팀 규칙을 운영하는 방법은 Git 협업 가이드와 함께 볼 수 있습니다.