1장, 깨끗한 코드

2022.02.24

코드가 존재하리라

  • 코드는 요구사항을 상세히 표현하는 수단이다.
  • 앞으로 프로그래밍 언어에서 추상화 수준은 점차 높아지리라 예상한다.
    더불어 특정 응용 분야에 적합한 프로그래밍 언어(domain-specific language) 수도 점차 많아지리라 예상한다.

나쁜 코드

  • 프로그래머라면 누구나 당연히 나쁜 코드로 고생한 경험이 있다.
  • 우리 모두는 자신이 짠 쓰레기 코드를 쳐다보며 나중에 손보겠다고 생각한 경험이 있다.
  • 나중은 결코 오지 않는다.
    ( 르블랑의 법칙, leblanc' law )

나쁜 코드로 치르는 대가

  • 나쁜 코드가 쌓일수록 팀 생산성은 떨어진다.
  • 시간을 들여 깨끗한 코드를 만드는 노력이 비용을 절감하는 방법일 뿐만 아니라 전문가로서 살아남는 길이라는 사실을 인정하자.
  • 나쁜 코드위 위험을 이해하지 못하는 관리자 말을 그대로 따르는 행동은 전문가답지 못하다.
  • 업무 기한을 맞추는 유일한 방법, 빨리 가는 유일한 방법은 언제나 코드를 최대한 깨끗하게 유지하는 습관이다.

깨끗한 코드란?

  • C++ 창시자, 비야네 스트롭스트룹

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

깨끗한 코드는 한 가지를 제대로 한다.

  • Object Oriented Analysis and Design with Application 저자, 그래디 부치

깨끗한 코드는 단순하고 직접적이다.
깨끗한 코드는 잘 쓴 문장처럼 읽힌다.

깨끗한 코드는 결코 설계자의 의도를 숨기지 않는다.

오히려 명쾌한 추상화와 단순한 제어문으로 가득하다.

  • 이클립스 전략의 대부, 데이브 토마스

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

  • Working Effectively with Legacy Code, 마이클 페더스

깨끗한 코드의 특징은 많지만 그 중에서도 모두를 아우르는 특징이 하나 있다.

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

고치려고 살펴봐도 딱히 손 댈 곳이 없다.
작성자가 이미 모든 사항을 고려했으므로. 고칠 궁리를 하다보면 언제나 제자리로 돌아온다.
그리고는 누군가 남겨준 코드, 누군가 주의 깊게 짜놓은 작품에 감사를 느낀다.

  • Extreme Programming Adventure in C# 저자, 론 제프리스

모든 테스트를 통과한다.

중복이 없다.

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

  • 위키 창시자, 익스트림 프로그래밍 공동 창시자, 스몰토크와 객체 지향의 정신적 지도자, 워드 커닝햄

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

우리는 저자다

프로그래머는 저자다. 저자에게는 독자가 있고, 독자와 잘 소통할 책임도 있다.
코드를 짤 당시의 노력을 보고 판단을 내릴 독자가 있다는 사실을 기억하자.
기존 코드에 기능 추가 혹은 수정하는 작업을 한다면, 아래와 같은 동작을 하게 된다.

변경할 함수로 스크롤해 내려간다.
잠시 멈추고 생각한다.
모듈 상단으로 스크롤해 변수 초기화를 확인한다.
다시 내려와 입력하기 시작한다.
..유사한 행위 반복

코드를 읽는 시간 대 코드를 짜는 시간 비율이 10 대 1을 훌쩍 넘는다.
새 코드를 짜면서 우리는 끊임없이 기존 코드를 읽는다.
주변 코드를 읽지 않으면 새 코드를 짜지 못한다. 주변 코드가 읽기 쉬우면 새 코드를 짜기도 쉽다.
그러므로 쉽게 짜려면, 읽기 쉽게 만들면 된다.

보이스카우트 규칙

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

체크아웃 할 때보다 좀 더 깨끗한 코드를 체크인한다면 코드는 절대 나빠지지 않는다.
한꺼번에 많은 시간과 노력을 투자해 코드를 정리할 필요가 없다.
변수 이름 하나를 개선하고, 약간의 중복을 제거하고, 복잡한 조건문 하나를 정리하면 충분하다.

시간이 지날수록 코드가 좋아지는 프로젝트에서 작업한다고 상상해보라!