클린 코드) 2장 핵심 정리

2장  의미 있는 이름

 

* 의도가 분명한 이름

- 변수, 함수, 클래스 등의 이름은 존재 이유, 수행 기능, 사용 방법 등의 의도를 알 수 있게 지어야한다.

ex) 

int d; // 경과 시간(단위 : 날짜)

의도를 전혀 드러내지 못하는 이름

int elapsedTimeInDays;
 
int daysSinceCreation;
 
int daysSinceModification;
 
int fileAgeInDays;

의도가 충분히 드러나는 이름

 

* 그릇된 정보를 피하라

- 코드에 남겨진 잘못된 단서는 코드 의미를 흐린다.

- ex) 배열로 구현된 그룹을 accountList로 이름 짓는 경우. 단순히 Accounts로 명명하는게 옳음.

- 서로 흡사한 이름은 피한다.

- 유사한 개념엔 유사한 표기법을 적용한다 (일관성). 일관성이 떨어지는 표기법은 그릇된 정보임.

 

* 의미있게 구분하라

- 컴파일러를 통과하기 위해 연속된 숫자를 붙이거나 불용어(noise word) 붙이는 방식은 피해야한다.

- 위에서 언급한 연속된 숫자, 불용어는 아무런 정보도 담지 않음. 의도가 드러나지 않음. 말 그대로 아무의미가 없음.

- 불용어 ex)

   product, productData, productInfo

   getActiveAccount(); , getActiveAccounts(); , getActiveAccountInfo();

   개념적으론 하나도 구분되지 않음. 그냥 중복.

- 읽는 사람이 차이를 알도록 명명.

 

* 발음하기 쉬운 이름을 사용하라

ex)

class DtaRcrd102 {
private Date genymdhms;
private Date modymdhms;
/*...*/
}
 
class Customer {
private Date generationTimestamp;
private Date modificationTimestamp;
/*...*/
}