[클린코드] 의미 있는 이름

다음 규칙들을 적용해서 코드 가독성이 높아져보자!

의도를 분명히 밝혀라

좋은 이름을 지으려면 시간이 걸리지만 좋은 이름으로 절약하는 시간이 훨씬 더 많다.

그릇된 정보를 피하라

일관성이 떨어지는 표기법은 그릇된 정보다.

의미있게 구분하라

• 컴파일러나 인터프리터만 통과하려는 생각으로 코드를 구현하는 프로그래머는 스스로 문제를 일으킨다.
• 다른 클래스를 ProductInfo 혹은 ProductData라 부른다면 개념을 구분하지 않은 채 이름만 달리한 경우다. Info나 Data는 a, an, the와 마찬가지로 의미가 불분명한 불용어다.
• 불용어는 중복이다.
• 읽는 사람이 차이를 알 수 있도록 이름을 지어라.
• 이름이 달라야 한다면 의미도 달라져야한다.

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

• 발음하기 쉬운 단어를 사용할 때 대화가 편해진다.
• 발음하기 어려운 이름은 토론하기도 어렵다. 바보처럼 들리기 십상이다. 프로그래밍은 사회 활동이기 때문이다.

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

• 문자 하나를 사용하는 이름과 상수는 텍스트 코드에서 쉽게 눈에 띄지 않는다는 문제점이 있다.
  상수에 버그가 있으나 검색으로 찾아내지 못한다.
• 검색하기 쉬운 이름이 상수보다 좋다.

인코딩을 피하라

이름에 불필요한 정보를 추가하지 말고 IDE를 활용하라.

• 헝가리식 표기법: 타입을 변수명에 명시하지 마라
• 멤버 변수 접두어 m_: 이름을 다르게 하지 않아도 멤버 변수임을 확인할 수 있어야 한다
• 인터페이스 클래스와 구현 클래스: 예외로, 구체 클래스(concrete class)에 Impl 접미어 인코딩은 필요하다

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

전문가 프로그래머는 명료함이 최고라는 사실을 이해한다.

기발한 이름은 피하라

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

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

• 추상적인 개념 하나에 단어 하나를 선택해 이를 고수하자.
  예를 들어, 똑같은 메서드를 클래스마다 fetch, retrieve, get으로 제각각 부르면 혼란스럽다.
• 메서드 이름은 독자적이고 일관적이어야 한다. 그래야 주석을 뒤져보지 않고도 프로그래머가 올바른 메서드를 선택한다.

말장난을 하지 마라

프로그래머는 코드를 최대한 이해하기 쉽게 짜야 한다.