1장 깨끗한 코드

 

Clean Code(클린 코드) | 로버트 C. 마틴 | 인사이트- 교보ebook

https://github.com/rkwhr0010/clean_code/tree/main/src

 

 

코드란 고객의 요구사항을 표현하는 언어다.

 

나쁜코드

당장의 일정 때문에 빠르게 "구동만 되는" 코드를 만들다보면, 시간이 지남에 따라 결국 그 코드 때문에 유지보수가 힘들어져 생산성 저하로 이어진다.

 

결과적으로 클린코드는 유지보수 용이성이 상승하여, 생산성 증대를 가져온다.

 

르블랑의 법칙

나중은 결국 오지 않는다. 지금해야 한다.

 

태도

코드 하나를 수정하려고 했는데, 다른 코드까지 수정해야 하는 경험을 해본 적 있을 것이다.

 

이는 개발자의 핵심이 크다.

 

요구사항이 자주 변경되거나, 일정이 촉박하다고 변명하면 안된다.

의사 선생님에게 간단한 외과 진료를 받는데, 빨리 치료받게 손씻지 말라고, 요구해서 의사가 손을 안 씻는 것을 본적 있는가?

 

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

 

난제

나쁜 코드는 업무 속도를 늦추게 되어있다.

하지만, 당장 눈앞에 시간을 맞추려고, 나쁜 코드를 양산하는 유혹에 빠진다.

 

이게 나쁜 것임을 알고 있지만, 눈 앞의 일정을 지키려고, 나쁜 코드를 양산한다.

 

결과적으로 보자, 종국엔 나쁜 코드 때문에 어차피 기한을 맞추지 못할 날이 올 것이다.

결국, 빨리 가는 유일한 방법은 클린 코드다.

 

깨끗한 코드

클린 코드와 나쁜 코드를 구분할 줄 아는 것과 직접 클린 코드를 작성하는 것은 다르다.

우리 목표는 클린 코드를 작성하는 방법을 채득하는 것이다.

 

비야네 스트롭스트룹

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

 

깨끗한 코드는 "보기에 즐거운" 코드다.

나쁜 코드는 코드를 고치면서 더 나쁜 코드를 만들게 한다.

 

깨진 창문 효과

깨진 창문은 관리되지 않는 느낌을 준다. 누구도 더 깨진다고 신경쓰지 않는다.

나중엔 자신도 창문을 깬다.

즉, 일단 창문이 깨지면 쇠퇴하게 된다.

 

깨끗한 코드는 세세한 사항까지 처리하는 코드다.(명명법, 메모리 누수 등)

 

깨끗한 코드는 한 가지를 잘한다. 나쁜 코드는 여러 일을 하려다 목적과 의도가 모호해 진다.

 

그래디 부치

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

 

깨끗한 코드는 잘 쓴 소설과 같이 읽혀야 한다.

기승전결이 명확한 것처럼 클린 코드를 읽을 때 이 코드의 목적과 개발자가 의도한 바를 알 수 있어야 한다.

 

데이브 토마스

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

 

읽기 쉬운 코드와 고치기 쉬운 코드는 별개다.

 

테스트 케이스가 없는 코드는 아무리 우하한 코드라도 깨끗한 코드가 아니다.

 

큰 코드 보다 작은 코드가 더 좋다.

 

마이클 페더스

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

 

깨끗한 코드는 누군가 시간을 들여 깔끔하고 단정하게 정리한 코드다.

 

론 제프리스(요약)

중요도 순 좋은코드

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

표현력이 좋은 코드

• 이름이 중요하다. 요즘 IDE는 이름 변경이 매우 쉬워 더 좋은 이름으로 변경하기 좋다.
• 책임이 많은 객체나 메서드를 찾아 여러 개로 나눠야 한다.

 

더 표현력이 좋은 코드

• 프로그램에서 유사한 요소 집합이 보이면, 추상화한다.
  다시말해, 추상 클래스나 인터페이스로 실제 구현을 감싼다.
  이렇게 되면, 호출하는 쪽은 인터페이스를 바라보기 때문에 변경에 강한 코드가 된다

작게 추상화, 중복 제거, 한 기능만

 

 

워드 커닝햄

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

 

깨끗한 코드는 독해를 할 필요가 없어야 한다. 명백하고 단순하기 때문이다.

 

접근법

의심하지 말고, 푹 빠져서 익혀볼 것, 그렇다고 다른 방법론이 거짓이라는 것이 아니다.

충분히 학습 후 다른 방법론도 익히면서, 견문을 넓일 것

 

우리는 저자다

실제로 개발을 시작하면, 코드를 읽는 시간이 코드를 짜는 시간보다 훨씬 많다.

따라서 읽기 쉬운 코드를 짜는 것은 중요하다. 그래야 코드를 빠르게 짤 수 있다.

 

보이스카우트 규칙

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

체크인 할 때보다 체크아웃 할 때 보다 더 깨끗한 코드를 만들면 된다.

큰 노력을 기울일 필요 없다.

중요한 것은 지속성이다.

 

 

원칙

SOLID

• SRP (Single Responsibility Principle)
  클래스는 변경할 때, 단 한 가지 이유만 존재해야 한다.
• OCP(Open Closed Principle)
  클래스는 확장엔 열리고, 변경에 닫혀 있어야 한다.
• LSP(Liskov Substitution Principle)
  상속받은 클래스는 기초 클래스로 대체할 수 있어야 한다.
• DIP(Dependency Inversion Principle)
  추상화에만 의존해야 한다. 구체화에 의존하면 안된다.
• ISP(Interface Segregation Principle)
  클라이언트가 필요한 만큼 인터페이스로 기능을 최소한으로 분리해 제공해야 한다.