02. 의미있는 이름
01. 의도를 분명히 밝혀라
- 변수나 함수 그리고 클래스 이름은 하단 세가지에 답을 할 수 있어야 한다.
1. 존재 이유는?
2. 수행 기능은?
3. 사용 방법은?
02. 그릇된 정보를 피하라
- 그릇된 단서를 코드에 남겨서는 안되며, 나름대로 널리 쓰이는 의미가 있는 단어를 다른 의미로 사용해도 안된다. 유사한 개념을 유사한 표기법을 사용한다. 이것도 정보다.
03. 의미있게 구분하라
- 연속된 숫자를 덧붙이거나 불용어를 추가하는 방식은 적절하지 못하며, 읽는 사람이 차이를 알도록 이름을 짓는다.
04. 발음하기 쉬운 이름을 사용해라
- 사람들은 단어에 능숙하며, 정의상으로 단어는 발음이 가능하기에 지적인 대화가 가능해진다.
05. 검색하기 쉬운 이름을 사용해라
- 이름 길이는 범위 크기에 비례해야 한다.
06. 인코딩을 피해라
- 컴파일러가 타입은 기억하고 강제하며, 접두어는 사용하지 않는다.
07. 자신의 기억력을 자랑하지 마라
- 루프에서 반복 횟수를 세는 변수는 전통적으로 한글자이기 때문에 제외한 나머지는 적절하지 못하며, 명료함이 최고이다.
- 클래스 이름은 명사나 명사구가 적합하다. ex) Customer, WikiPage, Account, AddressParser
- 메서드 이름은 동사나 동사구가 적합하다. ex) postPayment, deletePage, save
- 생성자를 중복정의 할 때는 정적 팩토리 메서드를 사용한다.
- 생성자 사용을 제한하려면 해당 생성자를 private로 선언한다.
08. 기발한 이름은 피하라
- 명료한 이름을 선택하여, 의도를 분명하고 솔직하게 표현해라
09. 한 개념에 한 단어를 사용하라
추상적인 개념 하나에 단어 하나를 선택해 이를 고수한다. 최신 IDE는 문맥에 맞는 단서를 제공한다. 예를 들어, 객체를 사용하면 그 객체가 제공하는 메서드 목록을 보여준다. 일관성 있는 어휘는 코드를 사용할 프로그래머가 반갑게 여길 선물이다.
10. 말장난을 하지마라
- 한 단어를 두 가지 목적으로 사용하지 마라. 다른 갠념에 같은 단어를 사용한다면 그것은 말장난에 불과하다. 프로그래머는 코드를 최대한 이해하기 쉽게 짜야 한다. 집중적인 탐구가 필요한 코드가 아니라 대충 훑어봐도 이해할 코드 작성이 목표다.
11. 해법 영역에서 가져온 이름을 사용하라
- 코드를 읽을 사람도 프로그래머이기 때문에 전산용어, 알고리즘 이름, 패턴 이름 등을 사용해도 괜찮다. 기술 개념에는 기술 이름이 가장 적합한 선택이다.
12. 문제 영역에서 가져온 이름을 사용하라
적절한 프로그래머 용어가 없다면 문제 영역에서 이름을 가져온다. 그러면 코드를 보수하는 프로그래머가 분야 전문가에게 의미를 물어 파악할 수 있다.
13. 의미 있는 맥락을 추가하라
- 스스로 의미가 분명한 이름이 없지 않으며 클래스, 함수, 이름 공간에 넣어 맥락을 부여하고 모든 방법이 실패하면 마지막 수단으로 접두어를 붙인다.
14. 불필요한 맥락을 업애라
- 의미가 분명한 경우에 한해서 긴 이름보다 짧은 이름이 좋다. 이름에 불필요한 맥락을 추가하지 않도록 주의한다.
의미있는 이름을 선택하려면 설명 능력이 뛰어나야 하고 문화적인 배경이 같아야 한다.
이 장에서 소개한 규칙 몇 개를 적용해 코드 가독성이 높아지는지 살펴보고 다른 사람이 짠 코드를 손본다면 리팩터링 도구를 사용해 문제 해결 목적으로 이름을 개선하자