의미있는이름.md

Chapter 2. 의미 있는 이름

Table of Contents

• 의미와 의도
  • 의도를 분명히 밝혀라
  • 그릇된 정보를 피해라
  • 의미 있게 구분하라
  • 한 개념에 한 단어를 사용하라
  • 의미 있는 맥락을 추가하라
• 문법
  • 발음하기 쉬운 이름을 사용하라
  • 클래스 이름
  • 메서드 이름

의미와 의도

의도를 분명히 밝혀라

• 주석이 필요하다면 의도를 분명히 드러내지 못했다는 말이다.
• 코드에 대한 이해와 변경이 쉬워진다.
• 상수만을 사용하지말고, 검색이 쉽게 변수명을 사용해라.
  • e.g. workDaysPerWeek = 5
• 명료한 이름을 선택해라.

그릇된 정보를 피해라

• 널리 쓰이는 의미가 있는 단어의 사용을 피한다.
  • e.g. 빗변(hypotenuse)를 hp라는 단어로 사용
• 실제 List가 아니라면 변수명에 List를 붙이지 않는다.
  • e.g. List가 아닌 경우 accounts 또는 accountGroup
• 흡사한 이름을 사용하지 않도록 주의한다.
• 일관성이 떨어지는 표기법은 그릇된 정보이다.

의미 있게 구분하라

• 이름이 달라야 한다면 그 의미도 달라져야 한다.
  • e.g. Customer와 CustomerObject

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

• 추상적인 개념 하나에 단어 하나를 선택한다.
  • e.g. fetch, retrieve, get

의미 있는 맥락을 추가하라

• 클래스, 함수, 이름 공간에 넣어 맥락을 부여한다.
  • e.g. street, houseNumber, city, state, zipcode를 Address라는 class의 하위에 둔다.
• 맥락을 개선함으로서, 함수를 쪼개기도 쉬워진다.

문법

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

• 올바른 영단어의 변수명을 사용하자.

//generate date, year, month, day, hour, minute, second의 축약형
❌ func genymdhms()

✅ func generateTimestamp()

문법적으로 올바른, 잘 읽히는 네이밍을 하라는 것 같습니다.

클래스 이름

• 명사나 명사구를 사용한다.
• 단, Manager, Processor, Data, Info 와 같은 단어는 피한다.

메서드 이름

• 동사나 동사구가 적합하다.