[클린 코드] #1 깨끗한 코드

클린 코드 #1 깨끗한 코드

#클린코드

나쁜 코드

나쁜 코드가 쌓일 수록 팀의 생산성은 떨어진다. 결국 언젠간 재설계하게 된다.
(생성형 AI가 던저준 코드를 그대로 복붙해서 프로젝트를 진행하면 이런 상황을 겪게 될 가능성이 높다)

개발자는 나쁜 코드의 위험성을 인지하고 상사의 무지한 요구를 거절해야 한다.

기한을 맞추기 위해 나쁜 코드를 양산한다고 변명하다면 이는 틀린 말이다. 나쁜 코드를 가지고 개발하면 기한을 맞출 수 없다. 가장 빠른 개발 방법은 코드를 최대한 깨끗하게 유지하는 것이다.

깨끗한 코드

깨끗한 코드를 작성하려면 깨끗한 코드가 뭔지 부터 알아야 한다.

• 논리가 간단해야 한다.
• 의존성은 최소화하고 각 의존성을 명확히 정의한다.
• 오류를 명시적인 전략으로 철저히 처리한다.
• 보기에도 즐거워야 한다.
• 효율적이여야 한다.
• 반드시 필요한 내용만 담아야 한다.
• 작성자가 아닌 사람도 읽기 쉽고 고치기 쉬워야 한다.
• 유닛 테스트 케이스와 인수 테스트 케이스가 존재해야 한다.
• 의미있는 이름이 붙는다
• 특정 목적을 달성하기 위해 하나의 방법만 제공한다.
• API는 명확하며 최소로 줄여야 한다.
• 주의깊게 짜야 한다.
  • 고치려고 살펴봐도 고칠 곳이 없어야 한다.
• 모든 테스트를 통과한다.
• 중복이 없어야 한다.
• 시스템 내 모든 설계 아이디어를 표현한다.
  • 아이디어를 명확하게 표현력있게.
• 클래스, 메서드, 함수 등을 최대한 줄인다.
• 유사한 요소로 이뤄지면 작게 추상화시킨다.
  • 실제 구현을 감싸준다.
• 짐작했던 기능을 그대로 수행한다면 깨끗한 코드이다.

읽기 쉽게 코드를 만들자
코드를 짜는 시간보다 읽는 시간이 많을 수 있다. 주변 코드를 쉽게 읽을 수 있어야 새로운 코드도 작성하기 쉽다.

보이스카우트 규칙
코드는 시간이 지나도 깨끗하게 유지되야 한다. 지속적으로 개선해나가야 한다.