클린 코드 작성법 - 읽기 좋은 코드의 비밀

클린 코드의 중요성

코드는 작성되는 것보다 읽히는 시간이 훨씬 많습니다. 40년간 수많은 코드를 읽고 쓴 저로서는 클린 코드가 생산성과 유지보수성을 결정한다고 확신합니다. 로버트 마틴(Uncle Bob)의 '클린 코드'는 필독서입니다. 클린 코드는 '작동하는 코드'를 넘어 '이해하기 쉬운 코드'입니다.

의미 있는 이름

변수, 함수, 클래스 이름은 의도를 드러내야 합니다. d 대신 elapsedTimeInDays처럼 명확하게 짓습니다. 약어를 피하고, 발음할 수 있는 이름을 사용합니다. 클래스는 명사, 메서드는 동사로 시작합니다. 이름을 잘 지으면 주석이 필요 없어집니다. 이름 짓는 데 시간을 아끼지 마세요.

함수 작성 원칙

함수는 한 가지 일만 해야 합니다(Single Responsibility). 함수는 짧을수록 좋습니다. 20줄을 넘으면 분할을 고려하세요. 인자 수는 적을수록 좋습니다. 3개 이상이면 객체로 묶으세요. 부수 효과(side effect)를 피하거나 명확히 표시하세요. 함수 이름이 하는 일을 정확히 반영해야 합니다.

주석과 포맷팅

좋은 코드는 주석이 필요 없습니다. 주석 대신 코드 자체를 명확하게 만드세요. 불가피한 경우에만 '왜(why)' 주석을 답니다. TODO, FIXME는 추적 가능하게 관리합니다. 일관된 포맷팅(들여쓰기, 중괄호 위치)을 유지합니다. 자동 포맷터(Prettier, Black)를 사용하세요.

지속적인 개선

보이스카웃 규칙: 코드를 처음 상태보다 깨끗하게 남겨라. 리팩토링은 일상적으로 수행합니다. 테스트가 있어야 안전하게 리팩토링할 수 있습니다. 코드 리뷰에서 클린 코드 원칙을 공유합니다. 완벽을 추구하지 말고 꾸준히 개선하세요. 클린 코드는 기술이자 습관입니다.