[클린코드] 4일차. 24-34pg | 의미있는 이름

 

4일차.

클린코드[1주차_목요일]
24-34pg 

 

 

#요약

 

1. 깨끗한 코드

2. 의미 있는 이름

소프트웨어에서 이름은 어디에나 쓰이기 때문에 이름을 잘 지으면 여러모로 편하다.

 

1) 의도를 분명히 밝혀라

2) 그릇된 정보를 피하라

- 진짜 list가 아니면 list도 쓰지 마라

- 서로 흡사한 이름을 쓰지 마라

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

 

3) 의미있게 구분하라

- 잘못된 예시 : moneyAmount와 money, customerInfo와 customer, accountData와 account

- 읽는 사람이 차이를 알도록 지어라

 

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

 

5) 검색하기 쉬운 이름을 사용하라

- 7, e는 검색이 어렵다.

- 이름의 길이는 범위 크기에 비례해야 한다.

- ex) 숫자 5 대신, WORK_DAYS_PER_WEEK 가 검색하기 쉽다.

 

6) 인코딩을 피하라

 

7) 자신의 기억력을 자랑하지 마라

- 독자가 코드를 읽으면서 변수 이름을 자신이 아는 이름으로 변환해야 한다면 그 변수 이름은 바람직하지 못하다.

- 명료하게 지어야 한다.

a. 클래스 이름 : 명사나 명사구가 적합

b. 메서드 이름 : 동사나 동사구가 적합

 

8) 기발한 이름은 피하라

- 의도를 분명하고 솔직하게 표현하라

 

9) 한 개념에 한 단어를 사용하라

- 추상적인 개념 하나에 단어 하나를 선택해서 고수한다.

 

10) 말장난을 하지 마라

- 한 단어를 두 가지 목적으로 사용하지 마라.

- 같은 맥락이 아니어도 일관성을 고려해서 선택하면 안된다.

- 집중적인 탐구가 필요한 코드가 아니라 태충 훑어도 이해할 코드를 작성해야 한다.

 

11) 해법 영역에서 가져온 이름을 사용하라

- 코드를 읽을 사람도 프로그래머다.

- 기술 개념에는 기술 이름이 가장 적합한 선택이다.

 

12) 문제 영역에서 가져온 이름을 사용하라

- 적절한 프로그래머 용어가 없으면 문제 영역에서 이름을 가져온다.