[Software Engineering] 클린코드

✔️ 클린코드

클린코드란?

• 가독성이 높은 코드로 얼마나 코드가 잘 읽히는지, 코드가 지저분하지 않고 정리된 코드인지를 나타내는 것
• 또는 코드를 작성하는 의도와 목적이 명확하며, 다른 사람이 쉽게 읽을 수 있어야 함
• 코드 리뷰를 통해 냄새나는 코드를 발견하면, 리팩토링을 통해 점진적으로 개선해 나감
• 전문가들이 표현한 클린코드
  1. 한 가지를 제대로 한다.
  2. 단순하고 직접적이다.
  3. 특정 목적을 달성하는 방법은 하나만 제공한다.
  4. 중복 줄이기, 표현력 높이기, 초반부터 간단한 추상화 고려하기 이 세가지가 비결
  5. 코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행하는 것
     
• 가독성을 높이기 위한 방법으로는
  1. 네이밍이 잘 되어야 함
  2. 오류가 없어야 함
  3. 중복이 없어야 함
  4. 의존성을 최대한 줄여야 함
  5. 클래스 혹은 메소드가 한 가지 일만 처리해야 함
• 클린코드를 만들기 위한 규칙
  1. 네이밍 : 변수, 클래스, 메소드에 의도가 분명한 이름을 사용
     잘못된 정보를 전달할 수 있는 이름은 사용하지 않으며, 범용적으로 사용되는 단어나 연속 숫자 등을 덧붙이는 방식은 피함
  2. 주석달기 : 코드를 읽는 사람이 코드를 작성한 사람만큼 잘 이해할 수 있도록 도와줘야 함
     주석은 반드시 달아야 할 이유가 있는 경우에만 작성하며, 코드를 빠르게 유추할 수 있는 내용에는 달지 않음
     즉, 설명을 위한 설명을 달지 않음
  3. 꾸미기 : 보기 좋게 배치하고 꾸밈
     규칙적인 들여쓰기와 줄바꿈으로 가독성을 향상시키도록 하며 일관성 있고 간결한 패턴을 적용해야 함
     또한 메소드를 이용해 불규칙한 중복 코드를 제거하도록 함
  4. 흐름제어 만들기
     왼족에는 변수를, 오른쪽에는 상수를 두고 비교하도록 함
     부정이 아닌 긍정을 다루도록 하며 do/while 루프를 피하고, 삼항 연산자 대신 if/else를 주로 사용하도록 함
  5. 착한 함수 : 함수는 가급적 작게, 한 번에 하나의 작업만 수행하도록 작성함
     별도의 함수로 구분하여 가독성을 향상시키도록 함