들어가기 앞서

이 글은 개발자 필독서인 클린 코드를 읽으며 습득한 내용을 정리한 글입니다. 모든 출처는 해당 저서에 있습니다.

---

1. 코드가 존재하리라

• 기계가 실행할 정도로 상세하게 요구사항을 명시하는 작업이 프로그래밍이며, 이를 명시한 결과가 코드다.
• 코드가 사라질 가망은 없다.
  • 코드는 요구사항을 상세히 표현하는 수단이기 때문
  • 막연한 요구사항만으로는 성공적인 시스템을 구현할 수 없기 때문

2. 나쁜 코드

• 왜 나쁜 코드를 작성하게 되는가?
  • 시간이 부족해서
  • 코드를 다듬는 데 시간을 썼다가 상사에게 욕 먹을까봐
  • 지겨워서 빨리 끝내려고
  • 밀린 업무를 해결하기 위해
• 구현에만 급급하여 나중에 손보겠다고 다짐하지만, "나중은 결코 오지 않는다".

3. 나쁜 코드로 치르는 대가

• 나쁜 코드는 개발 속도를 떨어뜨린다.
  • 코드를 고칠 때마다 엉뚱한 곳에서 문제가 발생하며, 매변 얽히고 설킨 코드를 '해독'해 얽히고 설킨 코드를 더하게 된다.
• 나쁜 코드가 쌓일수록 팀 생산성이 떨어지게 된다.
  • 생산성을 향상하기 위해 프로젝트에 인력을 추가로 투입한다 해도, 새 인력이 시스템 설계를 충분히 이해하지 못할뿐더러, 생산성을 높여야 한다는 극심한 압력 때문에 나쁜 코드를 더 많이 양산하게 된다.

3.1 원대한 재설계의 꿈

시간을 들여서 클린 코드를 만들려는 노력이 비용을 절감할 수 있는 방법이다.

• 새 시스템을 기존 시스템으로 대체하기 위해서 재설계를 진행하는 경우
  • 기존 시스템 기능을 모두 제공해야한다.
  • 개발을 진행하면서 기존 시스템에 가해지는 변경도 모두 따라잡아야 한다.
• 때문에 시간이 오래 걸리기도 한다. 새 시스템이 기존 시스템을 따라잡을 즈음이면 기존의 인력들은 떠나고 새로운 인력들만 남게 되고, 이들이 느끼기에 시스템이 엉망이라는 이유로 새 시스템 설계를 요구하게 된다.

3.2 태도

나쁜 코드에 대한 잘못은 전적으로 프로그래머에게 있다.

• 정보를 요구하지 않아도 적극적으로 정보를 제공해야 한다.
  • 프로그래머는 프로젝트를 계획하는 과정에 깊숙이 관여한다.
• 대다수의 관리자는 일정에 쫓기더라도 좋은 코드를 원한다. 이는 그들의 책임이므로 당연한 것이다.
  • 좋은 코드를 사수하는 일은 프로그래머들의 책임이다.
  • 나쁜 코드의 위험을 이해하지 못하는 관리자의 말을 그대로 따르는 것은 전문가답지 못한 행동이다.

3.3 원초적 난제

기한을 맞추는 유일한 방법은, 코드를 최대한 깨끗하게 유지하는 습관을 가지는 것이다.

• 프로그래머라면 나쁜 코드가 업무 속력을 낮춘다는 사실은 익히 알고 있으나, 기한을 맞추려면 나쁜 코드를 양산할 수 밖에 없다고 느낀다.
• 그러나 나쁜 코드는 개발 속도를 낮춤으로써 결국 기한을 놓치게 만든다.

3.4 클린 코드라는 예술

• 클린 코드와 나쁜 코드를 구분하는 것과 클린 코드를 작성할 줄 아는 것은 다르다.
• 클린 코드를 작성하기 위해서는 '코드 감각'이 필요하다.
  • 코드 감각이 있으면 좋은 코드와 나쁜 코드를 구분할 수 있다.
  • 나쁜 코드를 좋은 코드로 바꾸는 전략을 파악할 수 있다. 즉, 개선 방안 떠올린다.

3.5 클린 코드란?

👨‍💻 비야네 스트롭스트룹(Bjarne Stroustrup)

"나는 우아하고 효율적인 코드를 좋아한다. 논리가 간단해야 버그가 숨어들지 못한다. 의존성을 최대한 줄여야 유지보수가 쉬워진다. 오류는 명백한 전략에 의거해 철저히 처리한다. 성능을 최적으로 유지해야 사람들이 원칙 없는 최적화로 코드를 망치려는 유혹에 빠지지 않는다. 클린 코드는 한 가지를 제대로 한다."

• 보는 사람에게 즐거움을 선사해야 한다.
• 효율적이어야 한다.
  • 개발 속도뿐만 아니라, 자원을 낭비하지 않는 것도 중요하다.
• 나쁜 코드는 바람직하지 않은 결과를 초래한다.
  • 나쁜 코드를 고치면서 더 나쁜 코드를 만들게 된다.
  • "창문이 깨진 건물은 누구도 상관하지 않는다는 인상을 풍긴다. 일단 창문이 깨지고 나면 쇠퇴하는 과정이 시작된다."
• 세세한 사항까지 꼼꼼하게 정리해야 한다.
  • 오류 처리, 메모리 누수, 경쟁 상태, 일관성 없는 명명법 등 대충 넘어가지 말아야 한다.
• 한 가지에 '집중'해야 한다.
  • 나쁜 코드는 너무 많이 하려고 애쓰다가 의도가 뒤섞이고 목적이 흐려진다.
  • 각 함수, 클래스, 모듈은 주변 상황에 현혹되거나 오염되지 않은 채 한 길만 걸어야 한다.

👨‍💻 그래디 부치(Grady Booch)

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

• 클린 코드는 잘 쓴 문장처럼 읽혀야 한다. 즉, 가독성이 좋아야 한다.
• 해결할 문제의 긴장을 명확히 드러내야 한다. 명백한 해법을 제시하며 긴장과 문제를 풀어야 한다.
• 코드는 사실에 기반을 두어야 한다.
  • 반드시 필요한 내용만 담아야 한다.

👨‍💻 데이브 토마스(Dave Thomas)

"클린 코드는 작성자가 아닌 사람도 읽기 쉽고 고치기 쉽다. 단위 테스트 케이스와 수용 테스트 케이스가 존재한다. 의미 있는 이름이다. 특정한 목적을 달성하는 방법은 (어러 가지가 아니라) 하나만 제공한다. 의존성을 최소이며 각 의존성을 명확히 정의한다. API는 명확하며 최소로 줄인다. 때로는 필요한 정보 전부를 코드만으로 명확하게 드러내기 어려우므로 언어에 따라 문학적 표현이 필요하다."

• 다른 사람이 고치기 쉬워야 한다.
  • 읽기 쉬운 코드와 고치기 쉬운 코드는 다르다.
• 테스트 케이스가 없는 코드는 클린 코드가 아니다.
• 큰 코드보다 작은 코드에 가치를 두도록 한다. 코드는 작을수록 좋다.
• 인간이 읽기 좋은 코드를 작성해야 한다.

👨‍💻 마이클 페더(Michael Feather)

".... 클린 코드는 언제나 누군가 주의 깊게 짰다는 느낌을 준다. 고치려고 살펴봐도 딱히 손 댈 곳이 없다. 작성자가 이미 모든 사항을 고려했으므로, 고칠 궁리를 하다보면 언제나 제자리로 돌아온다. ...."

• 클린 코드란 주의 깊게 작성한 코드이다.
  • 누군가가 시간을 들여 깔끔하고 단정하게 정리했으며, 세세한 사항까지 꼼꼼하게 신경쓴 코드이다.

👨‍💻 론 제프리(Ron Jeffries)

"중복 줄이기, 표현성 높이기, 초반부터 간단한 추상화 고려하기. 내게는 이 세가지가 클린 코드를 만드는 비결이다."

• 중복을 피해야 한다.
  • 같은 작업을 여러 차례 반복한다면 코드가 아이디어를 제대로 표현하지 못한다는 증거다.
• 제대로 표현해야 한다.
  • 의미 있는 이름을 지어야 한다.
  • 개체나 메소드 당 하나의 기능만 수행해야 한다.
    • 개체가 여러 기능을 수행한다면 여러 개체로 나누는 것이 좋다.
• 작게 추상화해야 한다.
  • 집합을 추상화하면 '진짜' 문제에 신경을 쓸 여유가 생긴다. 간단한 기능이 필요한데 온갖 집합 기능을 구현하느라 시간과 노력을 낭비할 필요가 없어진다.

👨‍💻 워드 커닝엄(Ward Cunningham)

"코드를 읽으며 짐작했던 기능을 각 루틴이 그대로 수행한다면 클린 코드라 불러도 되겠다. 코드가 그 문제를 풀기 위한 언어처럼 보인다면 아름다운 코드라 불러도 되겠다."

• 클린 코드는 읽으면서 놀랄 일이 없어야 한다.
  • 코드를 독해하느라 머리를 쥐어짤 필요가 없어야 한다.
  • 읽으면서 짐작한 대로 돌아가야 한다.
• 명백하고 단순해야 한다.
• 언어를 단순하게 보이도록 해야한다. 이는 프로그래머의 책임이다.

4. 우리는 저자다

• 저자에게는 독자가 있으며, 저자에게는 독자와 잘 소통할 책임이 있다.
• 주변 코드를 읽기 쉬우면 새 코드를 짜기도 쉽다.
  • 주변 코드를 읽지 않으면 새 코드를 짜지 못한다.
  • 새 코드를 짜면서 끊임없이 기존 코드를 읽으므로 읽기 쉬운 코드가 매우 중요하다.

5. 보이 스카우트 규칙

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

• 지속적인 개선이 중요하다.
  • 코드는 잘 짰다고 전부가 아니다. 시간이 지나도 깨끗하게 유지해야 한다.
• 체크인할 때보다 좀더 클린 코드를 체크인 한다면 코드는 절대로 나빠지지 않는다.
• 한꺼번에 많은 시간과 노력을 투자해 코드를 정리할 필요는 없다.
  • 하나의 변수 이름 개선, 길이가 긴 함수 하나 분할, 약간의 중복 제거, 복잡한 if문 하나 정리 등이면 충분하다.

---

📖 참고

• 로버트 C. 마틴, 『Clean Code 클린 코드 애자일 소프트웨어 장인 정신』, 박재호·이해영 옮김, 케이앤피북스(2010), p35-52.