클린코드 2장 의미있는 이름

Kyung yup Lee·2020년 12월 3일
0

독서

목록 보기
2/2
  1. 의도를 분명히 밝혀라

    • 각 변수, 함수, 클래스가 하는 역할을 명확히 하라
  2. 그릇된 정보를 피하라

    • 코드를 읽는 이에게 헷갈리게 하는 정보를 주면 안됨.

      ex)

      • 널리 쓰이는 의미가 있는 단어 사용 X

      • List 구조를 사용하지 않는 컨테이너에 List라는 명명 X
        -> 실제 컨테이너가 list 형태여도 list를 사용하지 않는 것이 좋음.

      • 흡사한 이름 사용 X

  3. 의미 있게 구분하라

    • 읽는 사람이 차이를 알 수 있도록 이름을 지어야 한다.
    • NameString 이 Name 보다 나은 점은?
  4. 발음하기 쉬운 이름을 사용하라

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

    • 메서드나 클래스에서 커버하는 범위가 클수록 이름을 길게 하라
  6. 인코딩을 피하라

  1. 이름
  • 클래스 이름
    클래스 이름과 객체이름은 명사나 명사구가 적합함. 하지만 manager, processor, data, info 등의 명사는 피하는 것이 좋음

  • 메서드 이름
    동사나 동사구가 적합

  • 한 개념에는 한 단어만 사용. 가져온다는 같은 기능을 fetch, retrieve, get 다른 이름을 사용하

  1. 말장난 ㄴㄴ
  • 한 단어에 여러 개념이 들어가면 안됨.
    예를 들어 add라는 단어가 더한다는 단어인데, list에 값을 추가하는 것으로 사용하면 안됨
  1. 의미 있는 맥락을 추가하라
  • 여러 변수를 묶어놓으면 의미를 특정할 수 있는 변수가 어떤 특정 메소드에 단독적으로 사용되어 의미가 모호해지는 경우가 있다. 이럴 때는 의미있는 맥락을 추가해서 구분이 쉽게 되도록 하라.
profile
성장하는 개발자

0개의 댓글