- 코드 가독성
- 코드를 이해하기 쉽게 만드십시오
- 코드 형식의 일관성 유지
- 이름을 명확하고 일관되게 만드십시오.
- 기능
- 함수를 짧고 명확하게 유지
- 한 가지 일만 하는 함수 작성
- 함수는 인수를 최소화합니다.
- 주석
- 필요한 경우에만 주석을 사용하십시오.
- 코드가 설명하는 내용을 주석으로 대체하지 마십시오.
- 코드 자체가 주석 처리되어 있음을 충분히 명확히 하십시오.
- 개체 및 데이터 구조
- 객체는 데이터를 숨기고 기능을 노출합니다.
- 데이터 구조는 기능을 노출하고 데이터를 숨깁니다.
- 개체와 데이터 구조 간에 변환 비용이 있음을 이해합니다.
- 시험
- 코드를 작성하기 전에 테스트 작성
- 테스트 코드를 실제 코드와 동일한 수준의 품질로 유지하십시오.
- 단위 테스트, 통합 테스트 및 시스템 테스트를 구분하고 각각의 목적을 이해합니다.
- 수업
- 수업을 작고 명확하게 유지하십시오.
- 클래스는 단일 책임 원칙을 따릅니다.
- 꼭 필요한 경우가 아니면 클래스 상속을 피하십시오.
- 동시성
- 동시성 코드를 작성하기 전에 반드시 읽으십시오.
- 공유 상태 피하기
- 교착 상태 및 경쟁 조건 이해 및 방지
‘클린 코드’는 다음과 같은 특징을 가진 코드를 좋은 코드로 정의합니다.
- 읽을 수 있는 코드
- 간결하고 명확한 코드
- 일관된 코드
- 종속성이 낮은 코드
- 유지 가능한 코드
- 테스트하기 쉬운 코드
- 확장 가능한 코드
위와 같은 특징을 가진 코드를 작성하기 위해서는 코드를 작성할 때 일관된 가이드라인을 따르는 것이 중요합니다. 이를 위해 ‘클린코드’는 다양한 가이드라인과 예시를 제시한다.
예를 들어 코드 가독성을 높이려면 함수와 변수의 이름을 명확하고 일관되게 지정해야 합니다. 또한 들여쓰기, 줄 간격, 괄호 등과 같은 코드 형식을 일관되게 유지해야 합니다. 이렇게 하면 코드를 읽고 이해하는 데 드는 시간과 노력을 절약할 수 있습니다.
또한 함수를 작성할 때 한 가지만 수행하도록 작성해야 합니다. 즉, 함수의 역할과 책임이 명확해야 하며, 이를 달성하기 위해 함수 내부에 다양한 작업을 수행하는 코드를 작성하는 것은 지양해야 합니다. 이러한 방식으로 작성된 함수는 읽기 쉽고 재사용성과 유지보수성을 높입니다.
또한 ‘클린 코드’는 개체 및 데이터 구조, 테스트, 클래스, 동시성 등의 주제를 다룹니다. 이를 통해 좋은 코드 작성을 위한 다양한 가이드라인과 예제를 제공합니다.