[Clean Code] 2. 의미 있는 이름

 

의도를 분명히 밝혀라 p.22 

좋은 이름을 지으려면 시간이 걸리지만 좋은 이름으로 절약하는 시간이 훨씬 더 많다. 
그러므로 이름을 주의깊게 사펴 더 나은 이름이 떠오르면 개선하기 바란다. 그러면 (자신을 포함해) 코드를 읽는 사람이 좀 더 행복해지리라. 

변수나 함수 그리고 클래스 이름을 지을 때 질문에 모두 답 할 수 있어야 한다. 
1. 변수(혹은 메서드나 클래스)의 존재 이유는 ? 
2. 수행 기능은 ? 
3. 사용 방법은 ? 
주석이 필요하다면 의도를 분명하게 드러내지 못했다는 말이다. 

👩‍💻 지금까지 내가 짰던 코드에서 주석으로 의미를 드러낸게 얼마나 많은가... 지금 당장 내가 요즘 진행 중인 프로젝트에서 한 클래스만 들어가도 바로 보일 것이다... 지금 당장 그것부터 고치는 것으로 Clean Code 시작한다. 

 

 

 

그릇된 정보를 피하라 p.24

프로그래머는 코드에 그릇된 단서를 남겨서는 안 된다. 그릇된 단서는 코드의 의미를 흐리기 때문이다. 
나름대로 널리 쓰이는 의미가 있는 단어를 다른 의미로 사용해도 안된다. 

예를 들어 여러 계정을 그룹으로 묶을 때 AccountList 에서 List는 프로그래머에게 특수한 의미이다. 실제 계정을 담는 컨테이너가 List가 아니라면 프로그래머에게 그릇된 정보를 주는 것이다. List가 아니었다면 Accounts 라던가 AccountGroup 이런식으로 명명했어야 한다. 

또한 서로 흡사한 이름을 사용하지 않도록 한다. 

일관서이 떨어지는 표기법은 그릇된 정보이므로 유사한 표기법을 사용하자. 

이름으로 그릇된 정보를 제공하는 끔찍한 예로는 소문자 L과 대분자 O가 있다. (👩‍💻 이건 조금만 개발해봤다면 욕할 사 상황이다. 다행히 나는 한번도 L과 O를 사용해서 헷갈렸던 경험은 없다.. ^^ 다행) 

 

 

 

의미 있게 구분하라 p.25 

ProductInfo, ProductData 라고 부른다면 개념을 구분하지 않고 그냥 이름만 달리한것이다. 뭐가 뭔지 파악이 안되지 않는가..!! Info, Data, a, an, the 는 의미가 불분명한 불용어이다. 
불용어를 추가한 이름에서는 아무런 정보를 제공받지 못한다.

불용어는 중복이다. NameString과 Name 뭐가 다른가. Customer와 CustomerObject 차이를 알겠는가? 
읽는 사람이 차이를 알도록 이름을 지어라. 

 

 

 

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

사람들은 단어에 능숙하다. 우리 두뇌에서 상당 부분은 단어라는 개념만 전적으로 처리한다. 
그리고 정의상으로 단어는 발음이 가능하다. 말을  처리하려고 발달한 두뇌를 활용하지 않는다면 안타까운 손해다. 
그러므로 발음하기 쉬운 이름을 선택하라. 

👩‍💻 다른 분과 코드에 대해 얘기할 때 발음하기 쉬운 단어 이름을 가진 변수명으로 얘기하는게 낫지 않겠는가..ㅎ 

발음할 때.. 음.. 어.. 이러면서 얘기하는 것보단... 

 

 

 

검색하기 쉬운 이름을 사용하라 p.28

WORK_DAYS_PER_WEEK 를 찾기가 얼마나 쉬운지 생각해보라. 그냥 5를 사용한다면 5가 들어가는 이름을 모두 찾은 후 의미를 분석해 원하는 상수를 가려내야 하리라. 

👩‍💻 IDE에서든 어디서든 검색할 때 찾기 쉬운 이름으로 하자! 여기저기서 다 사용하거나 그런 이름으로 한다면 검색했을 때 우르르 나와서 거기서도 찾아야 하니,,, 

 

 

 

클래스, 메서드 이름  p.32

클래스 이름 
클래스 이름과 객체 이름은 명사나 명사구가 적합하다. Customer, WikiPage, Account, AddressParser 등이 좋은 예이다. Manager, Info, Data, Processor 같은 단어는 피하고, 동사는 사용하지 않는다.

메서드 이름 
메서드 이름은 동사나 동사구가 적합하다. postPyament, deletePage,save 등이 적합한 예이다. 
접근자, 변경자, 조건자는 javaBean 표준에 따라 get,set, is 를 붙인다. 

 

 

 

한 개념에 한 단어를 사용하라 p.33 

추상적인 개념 하나에 단어 하나를 선택해 이를 고수한다. 
예를 들어 똑같은 메서드를 클래스마다 get, retrieve, fetch 이렇게 제각각 부르면 나중에 사용할 때 혼란스럽다. 
어느 클래스에서 어느 이름을 썼는지 기억하기 어렵다. 

마찬가지로 동일 코드 기반에 controller, manager, driver를 섞어 쓰면 혼란스럽다. 

일관성 있는 어휘는 코드를 사용할 프로그래머가 반갑게 여길 선물이다. 

 

 

 

👩‍💻 사실 개발하면서 이름 짓는게 상당히 어렵다.변수 이름을 뭘로 할지.. 메서드 이름을 뭘로 할지 하다가 결국  똑똑한 인텔리제이의 도움을 받아서 ㅋㅋ 해결하곤 했는데... 클린 코드에서 알려준? 이 규칙들을 적용해서 지금 당장 진행중인 프로젝트에 적용해볼 예정이다. 

 

우선 내가 짠 코드부터 수정하고... 그 후에 보자...