Community

개발자 99% 커뮤니티에서 수다 떨어요!

← Go back
TIL 2장. 의미 있는 이름
#clean_code
2년 전
437


TIL (Today I Learned)

2022.02.20

오늘 읽은 범위

2장. 의미 있는 이름

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

  • 의도를 분명히 밝혀라 변수나 함수 그리고 클래스 이름은 다음과 같은 굵직한 질문에 모두 답해야 한다.
    -변수(혹은 함수나 클래스)의 존재 이유는?
    -수행 기능은?
    -사용 방법은?
    따로 주석이 필요하다면 의도를 분명히 드러내지 못했다는 말이다.

  • 그릇된 정보를 피하라 유사한 개념은 유사한 표기법을 사용한다. 이것도 정보다. 일관성이 떨어지는 표기법은 그릇된 정보다.

  • 의미 있게 구분하라 이름이 달라야 한다면 의미도 달라져야 한다. 읽는 사람이 차이를 알도록 이름을 지어라.

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

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

  • 인코딩을 피하라

  • 자신의 기억력을 자랑하지 마라
    클래스 이름 : 클래스 이름과 객체 이름은 명사나 명사구가 적합하다.
    메서드 이름 : 메서드 이름은 동사나 동사구가 적합하다.

  • 기발한 이름은 피하라 재미난 이름보다 명료한 이름을 선택하라.

  • 한 개념에 한 단어를 사용하라 예를 들어, 똑같은 메서드를 클래스마다 fetch, retrieve, get으로 제각각 부르면 혼란스럽다.

  • 말장난을 하지 마라

  • 해법 영역에서 가져온 이름을 사용하라

  • 문제 영역에서 가져온 이름을 사용하라

  • 의미 있는 맥락을 추가하라

  • 불필요한 맥락을 없애라

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

  • 이름을 지을 때는 최대한 짧게 짓는 것이 좋다고 생각했었는데 그것은 나만을 위한 것이 아니였나 글을 읽고 반성을 하게 되었다. 코드에 대한 적절한 이름을 지어 상대방이 봤을 때도 의도가 정확히 보이는 이해하기 쉬운 이름을 지을 수 있도록 노력해야겠다.

  • 앞으로 이름을 짓고 이 이름의 존재 이유와 수행 기능과 사용 방법에 적절한 이름인지 짚고 넘어가기!

  • 이름을 전달하는것도 하나의 정보라는 사실!

  • 좋은 이름으로 절약하는 시간이 훨씬 더 많다는 사실을 잊지 않기.