[Study][CleanCode - 1] 2. 의미 있는 이름

📋 목차.

2. 의미 있는 이름
    .의도를 분명히 밝혀라
    .그릇된 정보를 피해라
    .의미 있게 구분하라
    .발음하기 쉬운 이름을 사용하라
    .클래스, 객체 이름
    .메서드 이름
    .해법/문제 영역에서 가져온 이름을 사용하라.

---

✔️ 내용.

 

 

2. 의미 있는 이름

 

 이름을 잘 짓기 위한 몇 가지 규칙 소개

 

 

.의도를 분명히 밝혀라

 

변수나 함수, 클래스 이름은 다음과 같은 굵직한 질문에 모두 답해야 한다.

• 존재 이유
• 수행 기능
• 사용 방법

따로 주석이 필요하다면 의도를 분명히 드러내지 못했다는 말이다.

 

 

 int d; // 경과 시간(단위: 날짜)
 
 // 이름 d는 아무 의미도 드러나지 않는다. 측정하려는 값과 단위를 표현하는 이름이 필요하다.
 
 int elapsedTimeInDays;
 int daysSinceCreation;
 int daysSinceModification;
 int fileAgeInDays;

 

int 배열을 사용하는 대신, 간단한 클래스로 만들어도 된다.

클래스에 더해 아래 예시에서 isFlagged라는 좀 더 명시적인 함수를 사용해 FLAGGED라는 상수를 감춰도 좋다.

 

// Before
 for(int[] cell : gameBoard)
	if(cell[STATUS_VALUE] == FLAGGED)
 
// After
 for(Cell cell : gameBoard)
	if(cell.isFlagged())

 

---

 

.그릇된 정보를 피해라

 

 여러 계정을 그룹으로 묶을 때, 실제 List가 아니라면 accountList라 명명하지 않는다.
프로그래머에게 List라는 단어는 특수한 의미다. 계정을 담는 컨테이너가 실제 List가 아니라면 프로그래머에게 그릇된 정보를 제공하는 셈이다.
* 뒤에서 나오겠지만. 실제 컨테이너가 List인 경우라도 컨테이너 유형을 이름에 넣지 않는 편이 바람직하다.
그러므로 accountGroup, bunchOfAccounts, 아니면 단순히 Accounts라 명명한다.

 

---

 

.의미 있게 구분하라

 

 불용어(noise word)를 추가한 이름을 지양하자. 불용어는 중복이다. 변수 이름에 variable이라는 단어는 단연코 금물이다. 

NameString이 Name 보다 나은 점 이 있는가. Name이 부동소수가 될 가능성이 있는가. 혹여나 그럴 경우 앞서 얘기한 '그릇된 정보를 피해라'라는 규칙을 위반한다.

 

---

 

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

 

 지적인 대화가 가능하기 위해서는 읽기 쉬운 이름을 사용하는 것이 좋다.

 

private Date genymdhms; // 1.
private Date generationTimestamp; // 2.

1.의 경우 이름에 의미가 함축되어 있어 발음하기 어려울뿐더러 서로 간의 이해하는 과정이 필요하게 된다.
2.의 경우 발음할 수 있는 이름으로 쉽게 대화가 가능하다.

---

 

.클래스, 객체 이름

 

 클래스 이름과 객체 이름은 명사나 명사구가 적합하다.

 - 좋은 예) Customer, WikiPage, Account, AddressParser

 - 좋지 않은 예) Manager, Processor, Data, Info 등, 동사는 사용하지 않는다.

 

---

 

.메서드 이름

 

 메서드 이름은 동사나 동사구가 적합하다.

- 좋은 예) postPayment, deletePage, save

 

접근자(Accessor), 변경자(Mutator), 조건자(Predicate)는 javabean 표준에 따라 앞에 get, set, is를 붙인다.

 

String name = employee.getName();
customer.setName("mike");
if(paycheck.isPosted())

 

 생성자(Constructor)를 중복 정의(overload)할 때는 정적 팩토리 메서드를 사용한다.

메서드는 인수를 설명하는 이름을 사용한다.

 

Complex fulcrumPoint = Complex.FromRealNumber(23.0); // 1.
Complex fulcrumPoint = new Complex(23.0); // 2.

 

1. 코드가 2. 코드보다 좋다. 생성자 사용을 제한하려면 해당 생성자를 private로 선언한다.

 

 

---

 

.해법/문제 영역에서 가져온 이름을 사용하라.

 

 코드를 읽는 사람도 프로그래머라는 사실을 명심한다. 그러므로 전산 용어, 알고리즘 이름, 패턴 이름, 수학 용어 등을 사용해도 괜찮다. 모든 이름을 문제 영역(domain)에서 가져오는 정책은 현명하지 못하다. 같은 개념을 다른 이름으로 이해하던 동료들이 매번 고객에게 의미를 물어야 하기 때문이다.
 Visitor 패턴에 친숙한 프로그래머는 AccountVisitor라는 이름을 금방 이해한다. 기술 개념에는 기술 이름이 가장 적합한 선택이다.

 적절한 '프로그래머 용어'가 없다면 문제 영역에서 이름을 가져온다. 그러면 코드를 보수하는 프로그래머가 분야 전문가에게 의미를 물어 파악할 수 있다.

 우수한 프로그래머와 설계자라면 해법 영역과 문제 영역을 구분할 줄 알아야 한다. 문제 영역 개념과 관련이 깊은 코드라면 문제 영역에서 이름을 가져와야 한다.

---

📝 느낀점.

- 이름 짓기에 있어 의미있는 이름을 짓고자 깊은 생각을 가져야 할 거것 같다.
- 우수한 프로그래머가 되기 위해 해법 영역과 문제 영역의 구분을 가질 줄 알아야 할 것 같다.