클린 코드(Clean Code)란?

클린코드를 사용하려면 중요한 원칙이 있다. 

기본적이면서도 필요한 약속이니 기본적인거는 항상 숙지하자.

 

 

Clean Code

1. 제 3자가 읽어도 이해하기 쉽고 고치기 쉬운 코드

2. 다양한 기능이 아닌 한가지에만 집중하는 코드

3. 테스트 케이스가 있는 코드

 

객체지향은 유지보수하는데 사용되기 때문에 제 3자가 봐도 읽기 쉽고 에러 발생시 고치기 쉬운 코드가 되어야 한다.

 

 

 

의미 있는 Naming

 

의미가 연관되어 있는 Naming을 하는 이유는 코드 작성하는 것과 직결되기 때문에 각별히 신경써주어야한다.

POST로 보내는데 method = Delete로 지어서 보낸다면 연관도 없고 혼동만 오기 때문에 각별히 신경써주자.

 

 

 

 

주석

 

주석을 작성하는것은 나의 코드를 설명해주기 위해서 작성한다. 내가 이해를 못할때, 남을 이해시킬때 작성한다.

대신 위에 Clean Code 작성할때는 제3자가 봐도 쉽게 이해할 수 있는 코드를 작성해야 좋은 코드로 볼 수있다.

주석을 최소화 하는것은 좋지만 남들이 이해 못하는 코드를 작성한다면 없는것만도 못한다.

그니까 필요한곳에는 작성하되 가급적이면 Clean Code를 작성해보고 안된다면 주석을 달아주면 좋다.

 

 

미디터 법칙

 

모듈은 자신이 조작하는 객체의 속사정을 몰라야한다.

기차 충돌은 피하는게 좋다.

 

 

 

오류 처리

 

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

미확인 예외를 사용한다

예외에 의미를 제공한다

호출자를 고려해 예외 클래스를 정의한다.

외부 라이브러리를 사용할 떄에는 라이브러리용 클래스를 고려해보는것도 좋다.

Null을 반환하지 않는다.(Null만 반환된다면 어떤 오류인지 확인하기 어렵다)