클린코드에 대해서

클린코드란?

깨끗한 코드는 한 가지를 제대로 한다.
깨끗한 코드는 절대로 설계자의 의도를 숨기지 않는다. 단순하고 직접적이다.
코드를 일으면서 짐작했던 기능을 각 루틴이 그대로 수행하는 코드이다.
중복 줄이고, 표현력 높인다.

즉, 사람이 이해하기 쉬운 코드를 만드는 것이다.

클린코드의 주요 원칙

• 코딩 표준, 아키텍처 표준 및 설계가이드를 준수하기
• 단순한 것이 효율적이다. 복잡함을 최소화하기

디자인 패턴 SOLID 원칙

• Simple Responsibility Principle
  하나의 클래스는 하나의 책임만 가져야 한다.
• Open/Close Principle
  클래스는 확장에 대해 열려 있어야 하고, 변경에 대해서는 닫혀 있어야 한다.
• Liskov Substitution Principle
  서브 클래스는 메인 클래스에 기반을 두고 더 구체화하는 방식을 만들어야한다.
• Interface Segregation
  의존성을 줄여야 한다.
• Dependency Inversion Principle
  추상 클래스에 하위 클래스에 대한 내용이 들어가서는 안된다.

클린코드를 위한 기타 고려사항

1. 함수를 가급적 작게, 하나의 작업만 수행하도록 만든다.
2. 함수는 한 가지 일만 한도록 만든다.
3. 함수 인수는 없도록 하고, 필요하면 2개 이하로 만든다.

• 인수가 많을수록 테스트가 복잡해지고, 함수 이름만으로도 더 쉽게 이해가 된다.

4. try/catch 블록을 별도로 만든다.

• try, catch 블록 내에서 일어나는 코드는 별도의 함수로 빼내는 편이 좋다.

5. 읽기 쉽게 흐름제어 만들기

• 삼항연산자는 꼭 필요하거나 간단한 경우에 이용하기
• 조건은 부정보다는 긍정으로 사용하기

6. 좋은 주석을 작성하기

• 코드로 표현하지 못하는 정보를 제공
• 의도를 설명
• 결과를 경고
• 중요성을 강조

7. 오류처리

• 오류 코드보다 예외를 사용하기