[Clean Code] Chapter2. 의미 있는 이름

Clean Code

by. Robert C. Martin

02. 의미 있는 이름

이름을 잘 짓는 간단한 규칙을 소개한다.

의도를 분명히 밝혀라

좋은 이름을 짓는 시간 < 좋은 이름으로 절약하는 시간

변수 or 함수 or 클래스의 이름은 아래 질문을 만족해야 한다.

변수(혹은 함수, 클래스)의 존재 이유는?
수행 기능은?
사용 방법은?

만약 주석이 필요하다면, 의도를 분명히 나타내지 못한 것.

다음 코드는 무엇을 할까?

public List<int[] > getThem(){
    List<int[]> list1 = new ArrayList<int[]>();
    for (int[] x: theList) {
        if (x[0] == 4) {
            list1.add(x);
        }
    }
    return list1;
}

복잡한 문장은 없지만 이해하기가 어렵다.
theList에 들어있는 값은?
theList의 0번째는 무슨 값을 갖고 있는가?
4는 무슨 의미인가? 등등..

코드의 함축성 때문에

만약 위의 코드가 지뢰찾기라면?
theList를 gameBoard로 바꾸고, 각 칸은 단순 배열로,
0번째 값은 칸의 상태, 4는 깃발이 꽂힌 상태

public List<int[]> getFlaggedCells(){
    List<int[]> flaggedCells = new ArrayList<int[]>();
    for (int [] cell : gameBoard) {
        if (cell[STATUS_VALUE] == FLAGGED) {
            flaggedCells.add(cell);
        }
    }
    return flaggedCells;
}

코드를 보다 명확하게 파악 할 수 있다.
여기서 flagged라는 상수 대신 isFlagged와 같은 메소드를 활용해 상수를 감춰도 좋다.

그릇된 정보를 피하라

• 널리 쓰이는 의미가 있는 단어를 다른 의미로 사용하지 말아라.
  ex) aix, hp 등
  List라는 단어는 특수한 의미다.
• 서로 흡사한 이름을 사용하지 않도록 주의한다.
• 유사한 개념은 유사한 표기법을 사용한다. (일관성을 유지한다)

의미 있게 구분하라

동일한 범위 안에서 다른 두 개념에 같은 이름을 사용하지 못한다.

• 이름이 달라야 한다면, 의미도 달라야 한다.
• 연속적인 숫자를 덧붙인 이름, 불용어를 추가한 이름은 적절하지 못하다.
  • 아무런 정보를 제공 못함
  • 불용어는 중복이다(변수 이름에 variable)
• 읽는 사람이 차이를 알 수 있도록 이름을 지어라

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

발음하기 어려운 이름은 토론하기도 어렵다.
발음하기 쉬워야 지적인 대화가 가능해 진다.

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

• 문자 하나를 사용하는 이름과 상수는 쉽게 눈에 띄지 않음
  • 간단한 메서드와 로컬 변수만 한 문자
• 이름 길이는 범위 크기에 비례해야 한다
• 이름을 의미 있게 지으면 함수가 길어진다. 하지만, 검색이 쉽다.

인코딩을 피하라

멤버 변수 접두어

• 클래스와 함수는 접두어가 필요 없도록 작야아 한다.
• IDE를 사용하면 눈에 띄게 보여준다.
• 코드를 읽을 수록 접두어는 눈에 안들어 온다.

인터페이스 클래스와 구현 클래스

• 인터페이스 이름은 접두어를 붙이지 않는 편이 좋다.

자신의 기억력을 자랑하지 마라

• 읽는 사람이 코드를 읽으면서 변수 이름을 자신의 방식으로 변환한다면, 잘 못 짠 이름
  • 일반적으로 사용하지 않는 이름을 사용했다는 것
• 문자 하나만 사용하는 변수 이름은 문제가 있다
  • 루프에서 반복을 세는 i,j,k는 괜찮다(l은 절대 금지)
• 명료함이 최고다
  • 남들이 이해하는 코드

클래스 이름

• 명사 혹은 명사구
  • Manager, Processor, Data, Info 같은 단어는 피한다

메서드 이름

• 동사 혹은 동사구
  • 접근자, 변경자 조건자는 javabean 표준에 따라 get, set, is
• 생성자를 중복정의(overload) 할 때는 정적 팩토리 메서드를 사용
  • 생성자 사용을 제한 하려면 private로 선언

기발한 이름은 피하라

• 재미난 이르몹다 명료한 이름을 선택하라
• 특정 문화에서만 사용하는 농담은 피하자

한 개념에 한 단어를 사용하라

• 같은 메서드를 클래스마다 제각각으로 부르면 혼란 스럽다.
  • 어느 클래스에서 어떤 이름을 썻는지 기억해야함
• 메서드 이름은 독자적이고 일관적이어야 한다
  • 주석을 뒤져보지 않고도 프로그래머가 올바른 메서드를 선택할 수 있게

말장난을 하지 마라

• 한 단어를 두가지 목적으로 사용하지 마라.
  • 다른 개념에 같은 단어를 사용하는 것은 말장난
  ex) 두 값을 더하는 add와 새로운 값을 추가하는 add
• 코드를 최대한 이해하기 쉽게
  • 대충 봐도 이해할 코드 작성이 목표

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

결국은 코드는 프로그래머가 읽는다.
전산 용어, 알고리즘 이름, 패턴 이름 등을 사용해도 괜찮다.

오히려 Domain에서 이름을 전부 가져오는 정책이 더 멍청하다

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

• 적절한 용어가 없을 때만 가져온다
• 유지 보수하는 프로그래머가 분야 전문가에게 의미를 물어 파악 가능
• 만약 관련 깊은 코드면 영역에서 이름을 가져오는게 맞음

의미 있는 맥락을 추가하라

• 클래스, 함수, 이름 공간에 넣어 맥락을 부여
  • 모든 방법이 실패할 때 접두어를 붙인다.

firstName, lastName, street, houseNumber, city, state, zipcode

라는 변수가 있다.

변수를 전체를 보게 되면 주소라고 생각 할 수 있지만,
어느 메서드가 state하나만 사용하면?
주소라는 사실을 알기는 어렵다.

이때 addr이라는 접두어를 추가하면 더 이해하기 쉽다.
물론 Address라는 클래스를 사용하면 더 좋다

불필요한 맥락을 없애라

• 일반적으로 짧은 이름이 긴 이름 보다 좋다.
  • 단, 의미가 분명한 경우에 한해서