클린 코드 실습: 읽기 어려운 함수를 고치는 세 단계

‘클린 코드’는 규칙 몇 개를 암기하는 것보다 기존 코드를 안전하게 읽고 고치는 과정에서 익힐 수 있습니다. 실습에서는 작은 함수 하나를 골라 동작을 기록한 뒤 이름, 책임, 오류 처리를 차례로 개선하세요.

1. 현재 동작을 고정

정상 입력과 예외 입력의 결과를 테스트로 적습니다. 테스트 없이 구조를 바꾸면 개선인지 기능 손상인지 알기 어렵습니다. 입력과 출력이 불명확한 함수라면 먼저 호출 위치와 사용 목적을 확인합니다.

2. 의도가 드러나는 이름

temp, data 같은 이름을 역할이 드러나게 바꿉니다. 한 함수에서 검증, 저장, 응답을 모두 처리한다면 단계별로 분리하되 지나치게 쪼개지는 않도록 합니다. 파이썬 코드는 PEP 8의 이름과 배치 규칙을 기준으로 살펴볼 수 있습니다.

3. 변경을 검증하고 설명

테스트를 실행하고 변경 전후 동작이 같은지 확인하세요. 리뷰 설명에는 무엇을 바꿨는지보다 왜 읽거나 수정하기 쉬워졌는지 예를 남깁니다. 스타일 규칙 운영법은 협업 코드 리뷰 학습과 함께 확인하세요.

댓글 달기

이메일 주소는 공개되지 않습니다. 필수 필드는 *로 표시됩니다

위로 스크롤