[Book][Clean Code][TIL] 책 리뷰 02

Clean Code 클린코드 TIL(Today I Learned) 2022.02.20

📖 DAY 2

📝 오늘 읽은 범위

2장. 의미 있는 이름

📝 책에서 기억하고 싶은 내용을 써보세요.

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

  변수나 함수 그리고 클래스 이름은 다음과 같은 굵직한 질문에 모두 답해야 한다.

  • 존재 이유는?
  • 수행 기능은?
  • 사용 방법은?

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

  • 그릇된 단서는 코드 의미를 흐린다.
  • 나름대로 널리 쓰이는 의미가 있는 단어를 다른 의미로 사용하면 안된다.
  • 서로 흡사한 이름을 사용하지 않도록 주의한다.
  • 유사한 개념은 유사한 표기법을 사용한다. 이것도 정보다. 일관성이 떨어지는 표기법은 그릇된 정보다.

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

  • 긴 이름이 짧은 이름보다 좋다.
  • 검색하기 쉬운 이름이 상수보다 좋다.

• 클래스 : 명사 / 명사구, 메서드 : 동사 / 동사구 (get, set, is 붙이기) (p.32)
• 한 개념에 한 단어를 사용하라 (p.33)

  • 일관성 있는 어휘를 사용해라
  • ex) (fetch, retrieve, get) / (controller, manager, driver)

• 의미 있는 맥락을 추가하라 (p.35)

  • 클래스 ,함수, 이름 공간에 넣어 맥락을 부여한다.
  • 모든 방법이 실패하면 접두어를 붙인다.
  • es) 주소 : (addrFirstName, addrLastName, addrState)

• 불필요한 맥락을 없애라. (p.37)

  일반적으로는 짧은 이름이 긴 이름보다 좋다. 단, 의미가 분명한 경우에 한해서다. 이름에 불필요한 맥락을 추가하지 않도록 주의한다.

• 여느 코드 개선 노력과 마찬가지로 이름 역시 나름대로 바꿨다가는 누군가 질책할지도 모른다. 그렇다고 코드를 개선하려는 노력을 중단해서는 안된다. (p.38)
• 이 장에서 소개한 규칙 몇 개를 적용해 코드 가독성이 높아지는지 살펴보라. 다른 사람이 짠 코드를 손본다면 리팩터링 도구를 사용해 문제 해결 목적으로 이름을 개선하라. 단기적인 효과는 물론 장기적인 이익도 보장한다. (p.38)

📝 오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요.

평소 함수, 메서드, 변수 등의 이름을 작성할 때, 나름 신경을 쓰는 편이라고 생각했는데, 책에 나오는 규칙을 보니, 더 많은 신경을 써야겠다는 생각을 했다. 특히, 검색하기 쉬운 이름을 쓰라는 말은 정말 생각지도 못한 거였다! 내가 구현한 코드의 이름에 이 규칙들을 적용하여 가독성이 높아지도록 수정해야겠다.

📝 궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.

#코딩 #개발자 #노마드북클럽 #노개북 #clean_code