CleanCode 2장. 의미 있는 이름

Jini.Dev·2022년 5월 27일
0

2장. 의미 있는 이름

이름을 잘 짓는 간단한 규칙 몇가지.

  • 의도를 분명히 밝혀라
    변수의 존재 이유, 기능, 사용법 등이 따로 주석이 필요하지 않을 정도로 변수/함수/클래스명에 드러나야 한다.
    나쁜 예) int d; // 경과 시간(단위: 날짜)
    의도가 드러나는 이름을 사용하면 코드 이해와 변경이 쉬워진다.
    의미를 함축하거나 독자가 정보를 안다고 가정하지 말자.
    함수와 변수의 이름만 명확해도 함수가 하는 일을 이해하기 쉬워진다.

  • 그릇된 정보를 피하라
    그릇된 단서는 코드의 의미를 흐린다.
    보편적인 의미가 있는 단어를 다른 의미로 사용하지 말아라.
    개발자에게는 특수한 의미를 가지는 단어(List 등)는 실제 컨테이너가 List가 아닌 이상 accountList와 같이 변수명에 붙이지 말자. 차라리 accountGroup, bunchOfAccounts, accounts등으로 명명하자. (실제 컨테이너가 List인 경우라도 컨테이너 유형을 이름에 넣ㅈ 않는 편이 바람직하다.)
    비슷해 보이는 명명에 주의하자.

  • 의미 있게 구분하라
    불용어(noise word), 연속적인 숫자를 덧붙인 이름으로 구분하는 경우 주의
    클래스 이름에 Info, Data와 같은 불용어를 붙이지 말자. 정확한 개념 구분이 되지 않음
    예시
    Name VS NameString
    읽는 사람이 차이를 알도록 이름을 지어라.

  • 발음하기 쉬운 이름을 사용하라
    발음하기 어려운 이름은 토록하기도 어렵다.

  • 검색하기 쉬운 이름을 사용하라
    문자 하나를 사용한 변수 이름은 적합하지 못하다.
    변수 이름의 길이는 범위크기에 비례해야 한다.

  • 인코딩을 피하라
    유형이나 범위정보까지 인코딩에 넣으면 그만큼 이름을 해독하기 어려워진다.
    -헝가리안 표기법
      변수명에 해당 변수의 타입(String, Int 등)을 적지 말자
    -맴버 변수 접두어
      맴버 변수에 m_접두어를 붙이지 않아도 된다.
    -인터페이스 클래스와 구현 클래스
    인터페이스 클래스와 구현 클래스를 나눠야 한다면 구현 클래스의 이름에 정보를 인코딩하자.
    IShapeFactory 대신 ShapeFactoryImp 또는 CShapeFactory(클래스이름)

  • 자신의 기억력을 자랑하지 마라
    독자가 변수이름을 자신이 아는 이름으로 변환해야 할만한 변수명을 쓰지 말라.
    ex) URL에서 호스트와 프로토콜을 제외한 소문자 주소를 r이라는 변수로 명명하는 일
    전문가 프로그래머는 자신의 능력을 좋은 방향으로 사용 해 남들이 이해해는 코드를 내놓는다.

  • 클래스 이름
    명사 혹은 명사구를 사용하라.(Customer, WikiPage 등)
    Manager, Processor, Data, Info와 같은 단어는 피하고 동사는 사용하지 않는다.

  • 메서드 이름
    동사 혹은 동사구를 사용하라.(postPayment, save 등)
    접근자(Accessor), 변경자(Mutator), 조건자(Predicate)는 get, set, is로 시작하자.
    생성자를 오버로드할 경우 정적 팩토리 메서드를 사용하고 매서드는 인수를 설명하는 이름을 사용한다.
    생성자 사용을 제한하려면 해당 생성자를 private으로 선언한다.

  • 기발한 이름은 피하라
    특정 문화에서만 사용되는 농담은 피하고, 의도를 분명하고 솔직하게 표현하는 이름을 사용하라

  • 한 개념에 한 단어를 사용하라
    추상적인 개념 하나에 단어 하나를 사용하자.
    fetch, retrieve, get, controller, manager, driver ...

  • 말장난을 하지 마라
    다른 개념에 같은 단어를 사용한다면 그것은 말장난에 불과하다.
    한 단어를 두 가지 목적으로 사용하지 말자.
    코드를 최대한 이해하기 쉽게, 대충 훑어봐도 이해할 코드작성이 목표이다.

  • 해법 영역에서 가져온 이름을 사용하라
    개발자라면 당연히 알고 있을 JobQueue, AccountVisitor(Visitor pattern)등을 사용하지 않을 이유는 없다. 전산용어, 알고리즘 이름, 패턴 이름, 수학 용어 등은 사용하자.

  • 문제 영역에서 가져온 이름을 사용하라
    적절한 프로그래머 용어가 없거나,
    해법 영역과 문제영역으로 나누어 봤을때 문제영역과 관련이 깊은 용어의 경우
    문제 영역 용어를 사용하자.

  • 의미 있는 맥락을 추가하라
    클래스, 함수, 이름 공간에 의미를 넣어 맥락을 부여하라
    그래도 불분명하다면 접두어를 사용하자.
    ex) 주소의 일부로 사용되는 도시,주 의 경우 addrCity, addrState등으로 사용

  • 불필요한 맥락을 없애라
    Gas Station Delux 이라는 어플리케이션을 작성한다고 해서 클래스 이름의 앞에 GSD를 붙이지는 말자. GSDAccountAddress 대신 Address라고만 해도 충분하다.


    다른 사람이 짠 코드를 손본다면 문제 해결 목적으로 이름을 개선하라. 단기적 효과는 물론 장기적인 이익도 보장한다.
profile
정신 차려보니 개발자가 되어있었다.

0개의 댓글