1장. 깨끗한 코드

우리는 시간이 부족해서, 빠르게 짜기 위해서, 코드 다듬는데 시간을 썼다가 상사에게 욕먹을까봐 등의 이유로 코드 품질에는 신경 쓰지 않은채 결과만을 위해 코드를 작성하는 경우가 많습니다.

당장은 결과가 빠르게 만들어내고 코드 품질은 나중에 다듬어야지 하고 다짐하지만 나중에 코드를 다듬어 본적이 저부터 없습니다.

그렇게 만들어진 프로그램은 갈수록 유지보수 하기 힘들어지며 결국은 손 쓸수 없어 새로 만들거나 사라지게 됩니다.

한 번 쓰고 버릴 프로그램이 아니라면 우리는 시간이 조금 더 걸리더라도 코드를 작성할 때 부터 코드 품질에 신경을 쓸 필요가 있습니다. 요구사항은 자주 변하기 마련이니까요.

나중은 절대 오지 않는다. - 르블랑의 법칙 -

나쁜 코드로 치르는 대가

코드가 엉망인 프로그램을 유지보수 해본 경험이 있다면 이해하기 쉬울 것입니다.

작은 수정사항도 코드를 해석하는데 대부분의 시간을 소요하게 되고 열심히 찾아 수정했더니 사이드 이펙트가 발생해서 상당한 코드를 수정해야 하는 상황을 말입니다.

이 와중에 테스트 코드 마저 없다면 도박에 가까운 행동이 됩니다.

결국 시간이 흐를수록 생산성은 0에 수렴하게 되고 새로 만드는 지경에 다다르게 됩니다.

새로 만드는 와중에도 서비스는 해야하므로 유지보수 하는 팀과 새로 개발하는 팀이 나뉘어 개발을 진행하게 됩니다.

원대한 재설계의 꿈

결국 새로 개발하는 팀은 새로운 요구사항까지 적용된 버전으로 계속해서 만들어야 하고 책에서는 이런 과정이 10년이 넘게 걸리는 경우도 있었다고 소개합니다.

즉, 새로 만드는 작업도 비용이 상당하기 때문에 처음부터 코드 품질을 높여 유지보수가 가능하도록 구현하는 것이 중요합니다.

태도

일정이 촉박해서, 요구사항이 자주 변해서 등 나쁜 코드를 타 부서의 탓으로 돌리는 경우가 많지만 코드가 더러운 건 전적으로 프로그래머 탓입니다.

환자가 시간 없으니까 손 씻지 말고 수술하자고 해도 그럴 의사는 없으니까요.

누가 뭐라고 해도 우린 전문가이기 때문에 전문가 답게 좋은 코드를 사수해야 합니다.

원초적 난제

기한을 맞추려면 나쁜 코드를 양산할 수 밖에 없다고 느끼지만 이건 착각일 뿐입니다. 오히려 나쁜 코드로 인해 개발 속도가 늦어져 기한을 놓치는 경우가 더 많습니다.

빨리 가는 유일한 방법은 최대한 코드를 깔끔하게 유지하는 습관뿐입니다.

깨끗한 코드란?

비야네 스트롭스트룹 (C++ 창시자이자 The C++ Programming Language 저자)
나는 우아하고 효욱적인 코드를 좋아한다. 논리가 간단해야 버그가 숨어들지 못한다. 의존성을 최대한 줄여야 유지모수가 쉬워진다. 오류는 명백한 전략에 의거해 철저히 처리한다. 성능을 최적으로 유지해야 사람들이 원칙 없는 최적화로 코드를 망치려는 유혹에 빠지지 않는다. 깨끗한 코드는 한 가지를 제대로 한다.
우아한 코드

그래디 부치 (Object Oriented Analysis and Design with Application 저자)
깨끗한 코드는 단순하고 직접적이다. 깨끗한 코드는 잘 쓴 문장처럼 읽힌다. 깨끗한 코드는 결코 설계자의 의도를 숨기지 않는다. 오히려 명쾌한 추상화와 단순한 제어문으로 가득하다.
가독성 좋은 코드

큰 데이브 토마스 (OTI 창립자이자 이클립스 전략의 대부)
깨끗한 코드는 작성자가 아닌 사람도 읽기 쉽고 고치기 쉽다. 단위 테스트 케이스와 인수 테스트 케이스가 존재한다. 깨끗한 코드에는 의미 있는 이름이 붙는다. 특정 목적을 당성하는 방법은 (여러 가지가 아니라) 하나만 제공한다. 의존성은 최소이며 각 의존성을 명확히 정의한다. API는 명확하며 최소로 줄였다. 언어에 따라 필요한 모든 정보를 코드만으로 명확히 표현할 수 없기에 코드는 문학적으로 표현해야 마땅하다.
테스트 케이스

마이클 페더스 (Working Effectively with Legacy Code 저자)
깨끗한 코드의 특징은 많지만 그 중에서도 모두를 아우르는 특징이 하나 있다. 깨끗한 코드는 언제나 누군가 주의 깊게 짰다는 느낌을 준다. 고치려고 살펴봐도 딱히 손 댈 곳이 없다. 작성자가 이미 모든 사항을 고려했으므로. 고칠 궁리를 하다보면 언제나 제자리로 돌아온다. 그리고는 누군가 남겨준 코드, 누군가 주의 깊게 짜놓은 작품에 감사를 느낀다.
주의 깊게 작성한 코드

론 제프리스 (Extreme Programming Installed와 Extreme Programming Adventure in C# 저자)
켄트 벡이 제안한 단순한 코드 규칙으로 구현을 시작한다.
모든 테스트를 통과한다.
중복이 없다.
시스템 내 모든 설계 아이디어를 표현한다
클래스, 메서드, 함수 등을 최대한 줄인다.
중복을 피하라, 한 기능만 수행하라, 제대로 표현하라, 작게 추상화하라

워드 커닝햄 (위키 창시자, 익스트림 프로그래밍 공동 창시자, 디자인 패턴을 뒤에서 움직이는 전문가, 스몰토크와 객체지향의 정신적 지도자, 코드를 사랑하는 프로그래머들의 대부)
코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다. 코드가 그 문제를 풀기 위한 언어처럼 보인다면 아름다운 코드라 불러도 되겠다.

우리는 저자다

javadoc에서 @author 필드는 저자를 소개합니다. 우리는 저자입니다.

저자는 독자와 잘 소통할 책임이 있습니다.

코드를 짜는 시간과 코드를 읽는 시간의 비율은 10:1을 훌쩍 넘습니다. 우리는 끊임없이 코드를 읽기 때문에 읽기 쉬운 코드는 매우 중요합니다.

보이스카우트 규칙

조금 긴 함수 하나를 분할하고, 약간의 중복을 제거하고, 복잡한 if 문 하나를 정리하면 충분합니다.

캠프장은 처음 왔을 때보다 더 깨끗하게 해놓고 떠나라

결론

나쁜 코드와 좋은 코드, 다양한 기법들을 알려줄테니 반복 연습 해라 !