<클린코드> 완독하기 - 1

1. 의미 있는 이름

네이밍 과정은 개발을 진행할 수록 오랜 시간이 걸리는 일이다. 귀찮을 수도 있다. 하지만 명심하자! 좋은 이름으로 절약할 수 있는 시간이 더 크다는 것을.

1.1. 의도를 분명히 밝혀라

• 모호하고, 애매한 이름은 좋은 이름이 아니다. 분명한 의도를 밝히자

// 어떤 date인지 명확히 알 수 없다.
const date = '';

// 앞에 형용사를 붙혀 변수가 갖고 있는 의도를 명확히 하였다.
const createdDate = '';
const outDate = '';

1.2. 그릇된 정보를 피하라

• 코드에 그릇된 정보가 남아서는 안된다.

// 아래와 같은 네이밍은 잘못 되었다.
// List는 말 그대로 list interface 혹은 array를 사용했을때, 보통 명명한다.
const studentList = new Map();

// 아래와 같이 바꿔야 한다.
const students = new Map();

1.3. 검색하기 쉬운 이름을 선택하라.

• 코드 검색이 쉬운 단어를 택해야 한다.

1.4. 클래스명

• 클래스나 객체 명은 명사 혹은 명사구가 적합하다.
• Account, Customer 등의 단어들은 적합하다.
• Manager, Data, Info, Professor와 같은 단어들은 피한다.

1.5. 메서드명

• javabean 표준에 따라 접근자(Accessor), 변경자(Mutator), 조건자(Predicate)는 각각 get, set, is를 활용한다.