Clean Code


1. 코드 단위를 짧게 하라

  • 하나의 메소드는 하나의 역할만 하도록 한다.

  • 짧은 단위는 분석하기 쉽다.

  • 짧은 단위가 재사용하기 쉽다.

  • 메소드 이름을 의미있게 작성해서 가독성을 높여야한다.

2. 코드 단위는 간단하게 짜라

  • 단위를 커버하는 테스트 케이스를 최소화해야한다.

  • 간단한 단위는 복잡한 단위보다 이해하기 쉽고 수정하기도 쉽다.

  • 간단한 단위는 테스트하기 쉽다.

3. 코드는 한 번만 작성하라

  • 중복코드는 여러번 수정해야 한다.

4. 단위 인터페이스를 작게 하라

  • 작은 인터페이스가 이해하고 재사용하기 쉽다.

  • 인터페이스가 작아야 메소드를 수정하기 쉽다.

  • 파라미터가 5개 이상 넘어가면 코드를 읽기 어렵고 하는 일이 많아질 가능성이 크다.

5. 관심사를 모듈로 분리하라

  • 클래스를 나누어 관심사를 분리한다.

  • 특정 구현부는 인터페이스 안에 숨긴다.

6. 아키텍처 컴포넌트를 느슨하게 결합하라

  • 컴포넌트 의존성이 낮아야 분리해서 유지보수할 수 있다.

  • 컴포넌트 의존성이 낮아야 유지보수 책임을 분담할 수 있다.

  • 컴포넌트 의존성이 낮아야 테스트하기 쉽다.

9. 테스트를 자동화하라

  • 테스트를 자동화하면 반복 테스트가 가능하다.

  • 테스트를 자동화하면 효율적으로 개발할 수 있다.

  • 테스트를 자동화하면 예측 가능한 코드를 만든다.

  • 테스트를 작성하면 더 나은 코드를 작성할 수 있다.

  • 정상 케이스, 특이 케이스 모두 테스트한다.

10. 클린 코드를 작성하라

  • 단위 수준의 코드 악취를 남기지 말라.

  • 나쁜 주석을 남기지 말라.

  • 주석 안에 코드를 남기지 말라.

  • 죽은 코드를 남기지 말라.

  • 긴 식별자 이름을 남기지 말라.

  • 매직 상수를 남기지 말라.

  • 제대로 처리 안 한 예외를 남기지 말라.

11. References

  1. 주스트 뷔서 등 5인 . 이일웅 "클린 코드의 비결 유지보수 가능한 코딩의 기술 자바편" . 길벗