[Clean Code] 1장 깨끗한 코드

 

 

이 책은 좋은 프로그램 작성 요령을 설명하는 책이다.

이 책을 읽고나면 다음과 같은 것을 배울 수 있다.

• 좋은 코드와 나쁜 코드를 구분하는 능력
• 좋은 코드를 작성하는 방법
• 나쁜 코드를 좋은 코드로 바꾸는 실력

 

 

#1, 코드가 존재하리라

코드를 다루는 책이라고 해서 시대에 뒤떨어지는 책이 아니다.

코드보다는 모델이나 요구사항에 집중해야 한다고 생각할지 모른다.

하지만 그것은 큰 오산이다.

코드는 요구사항을 상세히 표현하는 수단이기 때문이다.

요구사항이 애매하게 주어지더라도 의도를 정확히 파악하여 프로그램을 완벽하게 실행하는 기계가 나오지 않는 이상,

코드의 중요성은 사라지지 않는다.

 

궁극적으로 코드는 요구사항을 표현하는 언어라는 사실을 명심한다.

 

 

#2, 나쁜코드

켄트 벡은 "좋은 코드가 중요하다는 다소 미약한 전제에 기반한다" 라고 한다.

이것은 동의하기 어려운 말로, 좋은 코드는 정말로 중요하다.

80년대 Killer App을 구현한 회사가 있었는데 회사는 망했다.

망한 이유는 바로 나쁜 코드 때문이다.

우리는 그밯게 작성한 코드를 보고 나중에 정리한다고 다짐한다.

하지만 우리는 르블랑의 법칙을 몰랐다.

 

나중은 결코 오지 않는다.

르블랑의 법칙(leblanc's Law)

 

 

#3, 나쁜 코드로 치르는 대가

나쁜 코드는 개발 속도를 크게 떨어뜨린다.

나쁜 코드가 쌓일수록 팀 생산성은 떨어진다.

 

나쁜코드 생성 → 생산성 떨어짐 → 인력 추가 → 나쁜코드 재생성 → 반복 → 생산성 0

 

 

#4, 원대한 재설계의 꿈

생산성이 바닥이면 팀은 관리층에게 재설계를 요청한다.

그렇게 새로운 팀은 기존 시스템을 100%제공하는 새 시스템을 만들어야한다.

하지만 새 시스템이 기존 시스템을 따라잡을 즈음이면 새로운 팀들은 떠나고, 또 다른 새로운 팀들이 재설계를 하자고 한다.

왜냐고? 코드가 엉망이니까.

 

결국 시간을 투자해 깨끗한 코드를 만드는 것이 비용을 절감하고 전문가로서 살아남는 길이다.

 

 

#5, 태도

좋은 코드가 어째서 순식간에 나쁜 코드로 변해버릴까?

잘못은 우리 프로그래머에게 있다.

 

프로젝트 실패는 우리에게도 커다란 책임이 있고, 특히 나쁜 코드가 초래하는 실패에는 더더욱 책임이 크다.

바빠서 그랬다? 상사가 시키는대로 해서 그랬다? 일정이 촉박하고 갑자기 변경해서 그렇다?

이런 말들을 할 수 있겠지만 결국 코드를 만드는 것은 우리 프로그래머들이고 좋은 코드를 만드는 일은 우리 프로그래머의 책임이다.

 

나쁜 코드의 위험을 이해하지 못하는 관리자 말을
그대로 따르는 행동은 전문가답지 못하다.

 

 

#6, 원초적 난제

나쁜 코드는 업무 속도를 늦춘다.

일정을 맞추려면 빠르게 작성하기에 나쁜 코드를 양산할 수 밖에 없다.

하지만 일정을 맞추는 유일한 방법은, 빠르게 가는 유일한 방법은

 

언제나 코드를 최대한 깨끗하게 유지하는 습관이다.

 

 

#7, 깨끗한 코드라는 예술

깨끗한 코드가 무엇인지 모르는데 깨끗한 코드를 만들려고 애써봤자 소용이 없다. 깨끗한 코드를 모르니까.

깨끗한 코드와 나쁜 코드를 구분할 줄 안다고해서 깨끗한 코드를 작성할 줄 안다는 뜻은 아니다.

 

깨끗한 코드를 작성하는 프로그래머는
빈 캔퍼스를 우아한 작품으로 바꿔가는 화가와 같다.

 

#8, 깨끗한 코드란?

프로그래머 수만큼이나 정의도 다양하기에 우리 분야에서 아주 유명하고 노련한 프로그래머들의 의견을 보자.

 

1. 비야네 스트롭스트룹(Bjarne Stroustrup)

C++ 창시자이자 The C++ Programming Language 저자

 

• 우아하고 효율적인 코드
• 논리가 간단해야 버그가 숨어들지 못한다.
• 의존성을 최대한 줄여야 유지보수가 쉬워진다.
• 오류는 명백한 전략에 의거해 철저히 처리한다. (메모리 누수, 경쟁 상태, 일관성 없는 명명법)
• 성능을 최적으로 유지해야 사람들이 원칙 없는 최적화로 코드를 망치려는 유혹에 빠지지 않는다.
• 깨끗한 코드는 한 가지를 제대로 한다.

 

깨끗한 코드는 보는 사람에게 즐거움을 선사하는 코드다.

깨끗한 코드는 세세한 사항까지 꼼꼼하게 처리하는 코드다.

나쁜 코드는 많은 일을 하려다가 의도가 섞이고 목적이 흐려진다.

 

깨끗한 코드는 한가지에 집중한다.

 

 

2. 그래디 부치(Grady Booch)

Object Oriented Analysis and Design with Application 저자

 

• 깨끗한 코드는 단순하고 직접적이다.
• 깨끗한 코드는 잘 쓴 문장처럼 읽힌다. (가독성)
• 깨끗한 코드는 결코 설계자의 의도를 숨기지 않는다.
• 오히려 명쾌한 추상화와 단순한 제어문으로 가득하다.

 

코드는 추측이 아니라 사실에 기반해야 한다.
반드시 필요한 내용만 담아야 한다.

 

 

3. '큰' 데이브 토마스('big' Dave Thomas)

OTI 창립자이자 이클립스 전략의 대부

 

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

 

실제로 읽기 쉬운 코드와 고치기 쉬운 코드는 엄연히 다르다.

코드가 우아하고 가독성이 높아도 테스트 케이스가 없으면 깨끗하지 않다.

큰 코드보다 작은 코드가 가치가 있고, 작을수록 좋다.

문학적으로 표현이란 인간이 읽기 좋은 코드를 작성하란 말이다.

 

깨끗한 코드는 작성자가 아닌 사람도 읽기 쉽고 고치기 쉽다.

 

 

4. 마이클 페더스(Michael Feathers)

Working Effectively with Legacy Code 저자

 

• 깨끗한 코드는 언제나 누군가 주의 깊게 짰다는 느낌을 준다.

 

깨끗한 코드는 시간을 들여 주의 깊게 작성한 코드다.

 

 

5. 론 제프리스(Ron Jeffries)

Extreme Programming Installed 와 Extreme Programming Adventure in C# 저자

 

• 모든 테스트를 통과한다.
• 중복이 없다.
• 시스템 내 모든 설계 아이디어를 표현한다.
• 클래스, 메서드, 함수 등을 최대한 줄인다.

같은 작업을 여러 차례 반복한다면 코드가 아이디어를 제대로 표현하지 못한다는 증거다.

표현력을 높여야하는데 이는 의미있는 이름뿐만 아니라 메서드가 여러 기능을 수행한다면 메서드 추출(Extract Method) 리팩터링 기법을 적용해 기능을 명확히 기술하는 메서드 하나와 기능을 실제로 수행하는 메서드 여러개로 나눈다는 의미이다. 객체 또한 마찬가지이다.

중복과 표현력만 신경 써도 깨끗한 코드라는 목표에 다가선다.

어떤 집합에서 특정 항목을 찾아내는 상황이 발생하면 추상 메서드나 추상 클래스를 만들어 실제 구현을 감싼다.

 

중복을 피하라.
한 기능만 수행하라.
제대로 표현하라.
작게 추상화하라.

 

 

6. 워드 커닝햄(Ward Cunningham)

위키 창시자, 피트 창시자, 익스트림 프로그래밍 공동 창시자, 디자인 패턴을 뒤에서 움직이는 전문가,

스몰토크와 객체 지향의 정신적 지도자, 코드를 사랑하는 프로그래머들의 대부

 

• 코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드이다.
• 코드가 그 문제를 풀기 위한 언어처럼 보인다면 아름다운 코드이다.

 

코드를 독해하느라 머리를 쥐어짤 필요가 없어야 한다.

언어를 단순하게 보이도록 만드는 열쇠는 프로그래머다!

 

읽으면서 짐작한 대로 돌아가는 코드가 깨끗한 코드이다.

 

 

#9, 우리들 생각

이 책은 깨끗한 변수 이름, 깨끗한 함수, 깨끗한 클래스를 만드는 방법을 소개한다.

이 책은 오브젝트 멘토 진영이 생각하는 깨끗한 코드를 설명한다.

이 책이 주장하는 기법들이 무조건 옳다기보다는 수십 년에 걸친 경험과 반복적인 시행착오로 습득한 교훈과 기법을 제시할 뿐이다.

 

 

#10, 우리는 저자다

우리는 저자다. 저자에게는 독자와 잘 소통할 책임이 있다.

다음에 코드를 짤 때는 자신이 저자라는 사실과 여러분의 노력을 보고 판단을 내릴 독자가 있다는 사실을 기억해야 한다.

 

새 코드를 작성하면 끊임없이 기존 코드를 읽는다.

기존 코드를 읽지 않으면 새 코드를 작성하지 못한다.

기존 코드를 읽어야 새 코드를 작성하므로 읽기 쉽게 만들면 작성하기 쉬워진다.

 

급하다면, 서둘러 끝내려면, 쉽게 작성하려면,
읽기 쉽게 만들면 된다.

 

 

#11, 보이스카우트 규칙

잘 짠 코드가 전부가 아니다.

시간이 지나도 언제나 깨끗하게 유지해야 한다.

 

한꺼번에 많은 시간과 노력을 투자해 코드를 정리하지 말고

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

이렇게 시간이 지날수록 코드가 좋아지는 프로젝트라면 어느 개발자가 좋아하지 않겠는가?

 

지속적인 개선이야말로 전문가 정신의 본질이다.

 

 

#12, 프리퀄과 원칙

이 책은 PPP(Agile Software Development : Principles, Patterns, and Practices) 의 프리퀄이다.

이 책에서는 다양한 설계 원칙을 산발적으로 거론한다. (SRP, OCP, DIP)

그런 원칙은 PPP에서 자세히 설명한다.

 

 

#13, 결론

예술에 대한 책을 읽는다고 예술가가 된다는 보장은 없다.

이 책을 읽는다고 뛰어난 프로그래머가 된다는 보장은 없다.

결국 이 책에 대한 정보와 교훈, 경험을 보고 어떻게 행동하느냐에 따라서 어떤 프로그래머가 될지 결정될 것이다.

 

연습해, 연습!

 

 

 

---

Clean Code / 로버트 C.마틴 지음 / 박재호, 이해영 옮김 / 인사이트