2장 : 의미 있는 이름

Y·2023년 8월 12일
0

클린 코드

목록 보기
2/14

*<클린 코드>를 참고하여 작성한 글입니다.

의미 있는 이름

  • 의도를 분명하게 밝혀라
  • 그릇된 정보를 피하라
    • 널리 쓰이는 의미가 있는 단어를 다른 의미로 사용하거나, 흡사한 이름을 사용하지 않도록 유의.
    • 유사한 표기법을 사용할 것.
  • 의미 있게 구분하라
    • 연속된 숫자를 덧붙이거나 불용어를 추가하는 방식은 적절하지 않음.
    • 불용어는 중복이다. ex)NameString vs Name
    • 읽는 사람이 차이를 알도록 이름을 지을 것.
  • 발음하기 쉬운 이름을 사용하라
  • 검색하기 쉬운 이름을 사용하라
  • 인코딩을 피하라
  • 자신의 기억력을 자랑하지 마라
    • 일반적으로 문제 영역이나 해법 영역에서 사용하지 않는 이름을 선택하지 말 것
  • 클래스 이름 : 클래스, 객체 이름은 명사나 명사구가 적합함. Customer, WikiPage, Account, AddressParser등이 좋은 예. Manager, Processor, Data, Info와 같은 단어는 피하고 (명확하지 않은 단어는 피하라는 뜻인듯..?) 동사는 사용하지 말 것.
  • 메서드 이름 : 동사나 동사구가 적합함. 생성자를 중복정의 할때는 정적 팩토리 메서드를 사용하고, 메서드는 인수를 설명하는 이름을 사용.
  • 기발한 이름은 피하라
  • 한 개념에 한 단어를 사용하라
    • 일관성 있는 어휘를 사용할 것
  • 말 장난을 하지 마라
    • 한 단어를 두 가지 목적으로 사용하지 말 것
  • 해법 영역에서 가져온 이름을 사용하라
  • 문제 영역에서 가져온 이름을 사용하라
  • 의미 있는 맥락을 추가하라
  • 불필요한 맥락을 없애라
    • 의미가 분명한 경우, 일반적으로 짧은 이름이 긴 이름보다 좋다. 이름에 불필요한 맥락을 추가하지 않도록 주의.
profile
개발자, 학생

0개의 댓글