clean code

clean code

 - 소스코드를 마든 개발자의 목적과 의도가 뚜렷한 코드

 - 버그 없이 소스코드가 잘 동작하면 신경쓰지 않는 경우가 있다. 이 때 작은 문제가 커져서 더 많은 인력과 자원이 할애될 수도 있다. 

   따라서 코드를 가독성 좋게 만들 필요가 있다.

 

 나쁜 코드

" Later is Never " - Leblanc's Law

위 문구는 '르블랑의 법칙'으로 잘 알려진 "나중은 결코 오지 않는다."라는 유명한 구절입니다.

개발자가 아무리 코드를 잘 짜려고 온갖 심혈을 기울여도 테스트 과정에서 발견되는 오류는 피할 수 없을 것입니다.

나쁜 코드는 금이 간 창문과 같습니다.

처음에는 창문에 금만 갔을 뿐, 창문으로써 제 기능을 하지만 시간이 지날수록 그 금이 커져 결국 창문이 깨져버릴 수 있습니다. 

 

 ✅ 너무 긴 코드

 ✅ 너무 많은 분기문 또는 중첩문

 ✅ 중복이 많은 코드

 ✅ 변수 및 함수 이름을 난해하게 작성한 경우

 ✅ 종속성이 높은 코드

 

 

 좋은 코드 (clean code)

 👍🏻 한 문장에 6단어 이하 사용, 그 이상이면 글이 눈에 잘 안들어와요!

 👍🏻 논리가 간단하고 가독성이 좋은 코드

 

clean code의 주요 원칙 

 - Follow Standard Convention:

    코딩의 표준, 아키텍처 표준 및 설계 가이드(Convention)을 준수하라.

 - Keep it simple, Stupid:

    단순한 것이 효율적이다. 복잡한 것은 멀리하라.

 - Boy Scout Rule:

    참조되거나 수정되는 코드는 원래보다 깔끔해야 한다.

 - Root Cause Analysis:

    항상 근본적인 원인을 찾아라, 그렇지 않으면 반복될 것이다.

 - Do not multiple language in one source file:

    하나의 파일은 하나의 언어로 작성하라.

 

그 외 좋은 코드를 위한 규칙

 - 의도가 분명하고 발음하기 쉬운 변수명, 함수명, 클래스명으로 코드를 작성한다.

 - 함수 기능 중 세부사항, 즉 직관적으로 파악하기 힘든 내용은 주석으로 남긴다.

 - 읽기 쉬운 흐름 제어를 만들기 위해 조건문 혹은 반복문을 최적화시킨다.

 - 하나의 함수는 하나의 작업만 수행하도록 작게 만든다.

 - 같은 로직을 처리하는 코드가 여러 곳에 있지 않도록 DRY(Do not Repeat Youself)하게 코드를 작성한다.

 

결론

clean code의 이점은 다음과 같습니다.

 

1. 가독성이 좋다

2. 의존성을 줄여준다.

3. 오류 발생 확률이 줄어든다.

4. 소스코드의 성능이 최적화된다.

5. 소스코드 로직의 의도가 잘 드러난다.

6. 코드를 작성하지 않은 다른 사람도 쉽게 수정할 수 있다.

7. 테스트 코드를 작성하기 쉽다.