Clean Code / 02 20 2022

변수, 함수, 클래스의 이름을 잘 짓는것은 굉장히 중요하다.

 

무엇보다 의도가 분명하고 독자가 이해하기 쉽게 적는것이 중요하다.

 

좋은 코드는 흝어봐도 술술 읽혀야하는데,

 

이를 위해 중복되는 값을 상수로 만들고 이름을 분명히하여 이해하기 쉽게 만들 수 있겠다.

 

또한 찾는 값을 검색이 쉽도록 변수로 만들고 변수 명을 적당히 길게(찾기 쉽도록) 만드는것도 한 방법이다.

 

 

잘못된 정보를 피하는것도 좋은 방법이다.

 

책의 예시로 List 자료형을 사용 시, 그 변수 명을 customerList로 쓸 수 있다.

 

그러나 실제로 변수의 자료형이 단순 객체의 배열이거나 할 경우에는 변수 명에 List를 붙이는것을 삼가야한다.

 

독자에게 잘못된 정보를 제공할 수 있기에, 대신 groupOfCustomers, bunchOfCustomers 등의 

 

변수명을 사용할것이 권장된다.

 

 

또한 추상적인 접두사, 접두어 등을 피하자.

 

클래스명, 변수명 등에 Data, Info 등이 추가되는것은 혼란스럽다.

 

만약 Customer 클래스 내에 필드 값으로 money와 moneyAmount라는 변수 이름이 주어졌다고하자.

 

독자는 그 두 필드의 차이를 알기힘들다.

 

차이를 명확하게 하는 단어를 사용해주자.

 

 

클래스 이름으로는 보통 명사, 명사구를 사용하며 동사의 사용을 금한다.

 

반대로 메소드 이름으로는 동사와 동사구를 사용하며, 접근자, 번경자, 조건자는

 

각 get, set. is 를 붙이는것이 권장된다.

 

 

기발하고 유머스러운 이름을 피하자.

 

같은 문화를 공유하는 조직 내에서는 재미있을 수 있지만, 

 

다른 독자가 이를 체험하게된다면 당혹스러울 수 있다. 

 

개발에는 유머보다 직관적이고 솔직함이 요구된다.

 

 

결국 이러한 프로세스는 언어 문장 처럼 읽히는 코드를 작성하기 위함이다.

 

이를 통해 개발자는 코드 가독성을 제고하고 생산성 측면에서 장기적으로 유리함을 체험할 수 있다.