[CleanCode]의미 있는 이름-의도를 분명히 밝혀라

 

코드를 처음 시작할 때 흔히

int d;	// 날짜

이런 식으로 한글자로 변수명을 적습니다.

이름이 좀 길어져도 상관없습니다

 

클래스/함수/변수 무엇이든 읽자마자 어떤 것인 지 알 수 있어야 합니다.

int daySinceCreation;
int fileAgeInDays;

너무 길지 않나? 생각할 수 있지만 훨씬 낫습니다.

주석이 없어도, 변수명을 기억하지 않아도 바로 알 수 있습니다.

---

 

연속적인 숫자 이름은 아무런 정보를 제공하지 못한다

 

public void makeNames(String param1, String param2) { }

param1, param2 ...param4 까지 흔히 볼 수 있는 작명입니다.

하지만 아무른 의도를 읽을 수 없습니다.

---

변수타입을 이름에 넣지 마라(헝가리안 표기법 금지)
Data, Info, Value 모두 금물

List<String> customerData;
List<String> customerInfo;

String nameStr;

int gridRowNum;
int checkedValue;

흔히 보이는 변수명들입니다.

List<String> customerList;

String customerName;

int checkedRow;

Data, Info, Str, Num, Value가 없어도 개발자는 충분히 타입을 유추할 수 있습니다.

❗ a, an, the도 마찬가지로 불필요한 불용어입니다.

---

반대로 타입을 명시하는 경우

 

Collection 타입은 변수명에 명시하는 것을 허용합니다.

Interface를 구현하는 클래스에서는 implement의 약자 Impl을 붙이는 것을 허용하는 편입니다.

하지만 Interface에는 접두어를 붙이지 않는 편이 좋습니다.

List<String> studentNameList;
HashMap<int, String> studentIdMap;

---

그릇된 정보를 피하라

 

어떤 목록을 가져온다고 해봅시다.

개발자가 Map타입 변수명에 List (목록)을 넣는다면?

HashMap<String, String> customerList = new HashMap<String, String>();

 

이후 코드를 고치는 다른 사람은 customerList.add()가 왜 안되는 지 잠시 당황할 수 있습니다.

---

 

직각삼각형의 빗변 hypotenuse를 약어로 hp를 변수명으로 사용하면 어떻게 될까요.
후에 코드를 읽는 사람은 hp 기업을 먼저 떠올릴 수 있습니다.
혼동을 주는 단어선택은 피하는 게 좋습니다.

---

 

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

 

책에 나온 예제로 실제 어느 회사가 사용했던 변수명이라고 합니다.

private Date genymdhms;

generate date, year, month, day, hour, minute, second 의 약자로요.

 

"젠 와이 엠디 에이취 엠 에스"

"젠 야 무다 힘즈"

 

직원들은 등으로 부르고는 했다고 합니다. 

 

private Date generationTimestamp;

만약 이처럼 바꿨다면 서로 대화하기 더 편했겠죠.

---

이름 길이는 범위 크기에 비례해야 한다
검색하기 쉬운이름을 사용하라

 

 

 

널리 사용될 수록 긴이름 보다는 짧은 이름이 좋다는 말입니다.

이름이 너무 짧아도 문제이지만, 자주 사용되는 클래스/함수/변수명이 너무 길어도 사용하기 어렵습니다.

---

접두어_금지

 

클래스와 함수는 접두어 _ 가 필요없을 정도로 작아야합니다.

접두어는 옛날에 자주 사용하던 작명법이라고 합니다.

---

❗ 이 외에도 한 단어를 두가지 목적으로 사용하는 것 금지.

좀 더 의미있게 아래처럼 작명할 것 등이 있습니다.
city -> addrState 
houseNumber -> addrFirstName