[Clean Code] 클린코드 2장 : 의미 있는 이름

클린코드 2장(로버트C. 마틴)을 읽고...

 

의도를 분명히 밝혀라

변수의 존재이유, 수행기능, 사용 방법에 따로 주석이 필요하다면 의도가 분명히 드러나지 못했음을 나타낸다.

알파벳 d는 아무 의미도 드러나지 않기 때문에, 측정하려는 값과 단위를 표현하는 이름이 필요하다.

 

int d; //경과 시간

int elapsedTimeInDays;
int daySinceCreation;
int daySinceModification;
int fileAgeInDays;

 

아래와 같은 코드는 변수 3개, 상수 2개임에도 코드가 하는 일을 짐작하기 어렵다.

 

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

 

1. theList에 무엇이 들었는가?

2. theList에서 0번째 값이 왜 중요한가?

3. 값 4는 무슨 의미인가

4. 함수가 반환하는 리스트 list1을 어떻게 사용하는가?

 

 

문제는 코드의 단순성이 아닌 함축성이다.

코드 자체에서 코드의 맥락이 명시적으로 드러나지 않는다.

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

 

위 코드를 보다시피, 코드의 단순성은 변하지 않았다. 연산자와 상수의 수, 들여쓰기 단계 모두 동일하다.

하지만 상수와 변수에 의미를 부여함으로써 가독성이 뛰어나게 되었다.

public List<Cell> getFlaggedCells() { 
    List<Cell> flaggedCells = new ArrayList<Cell>(); 
    for (Cell cell : gameBoard) 
    	if (cell[.isFlagged())
            flagedCells.add(cell); 
   	return flaggedCells; 
}

 

더 나아가, int배열 대신 Cell 클래스를 만들고, isFlagged라는 함수를 사용해 FLAGGED라는 상수를 감출 수도 있다

 

 

그릇된 정보를 피하라

· hp aix, sco는 변수이름으로 적합하지 않다.

  유닉스 플랫폼이나 유닉스 변종을 가리키는 이름이기 때문이다.

  직각삼각현의 빗변(hypotenue)을 구현할때 hp가 훌륭한 약어처럼 보이지만 hp라는 변수는 그릇된 정보를 제공하게 된다.

 

· 여러 계정을 묶을 때, 실제 리스트가 아니라면 accountList라 명명하지 않는다.

  accountGroup, bunchOfAccounts, Accounts식으로 이름을 지어야한다.

 

· 서로 흡사한 이름을 사용하지 않아야 한다.

  한 모듈에서는 XYZControllerForEfficientHandlingOfString라는 이름을 사용하고,

  조금 떨어진 모듈에서는 XYZControllerForEfficientStorageOfString라는 이름을 사용한다면?

  그 차이를 알아채기가 매우 힘들다.

 

· 유사한 개념은 유사한 표기법을 사용한다. (이것도 정보다.)

  일관성이 떨어지는 표기법은 그릇된 정보다.

 

· 최신 자바 환경은 코드 자동 완성 기능을 제공하는데,

  이름 몇 자만 입력한 후 핫키 조합을 누르면 후보 목록이 뜬다.

  후보 목록에 유사한 개념이 알파벳 순으로 나오고 각 개념 차이가 명백히 드러나면 이 기능은 유용해진다.

  하지만 개발자들은 객체에 달린 주석이나 메서드 목록을 살펴보지 않은 채 이름만 보고 객체를 선택한다.

 

· 소문자 'l'이나 대문자 'O'는 숫자 '0'과 '1'로 보이므로 사용하지 않는것이 좋다.

  아래와 같은 코드에서 l과 1, O와 0는 구분하기가 어렵다.

int a = l;
if (O == l)
    a = O1;
else
    l = 01;

 

 

의미 있게 구분하라

연속된 숫자를 덧붙이거나 불용어를 추가하는 방식은 적절하지 못하다.

public static void copyChars(char a1[], char a2[]){
    for (int i =0; i <a1.length; i++){
    	a2[i] = a1[i];
    }
}

 

a1, a2, ... aN과 같이 연속적인 숫자를 덧붙인 이름은 아무런 정보를 제공하지 않는다.

위 코드에서 함수 인수 이름으로 source와 destination을 사용한다면 의도가 더 잘 드러날 것이다.

 

또한, Product라는 클래스가 있다 가정하자.

다른 클래스를 ProductInfo, ProductData라 부른다면 개념 구분 없이 이름만 달리하게 된 것이다.

 

다음과 같은 오류도 프로젝트에 참여한 프로그래머는 어느 함수를 호출할지 구분할 수 없다.

getActiveAccount();

getActiveAccounts();

getActiveAccountInfo();

 

즉, 읽는 사람이 차이를 알도록 이름을 지어야한다.

 

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

발음이 가능한 단어를 선택하는 것이 유리하다.

//발음하기 어려운 변수들
class DtaRcrd102 {
    private Date genymdhms;
    private Date modymdhms;
    private final String pszaint = "102";
    /* ... */
}

//발음이 용이한 변수들 -> 소통이 가능해짐
class Customer {
    private Date generationTimestamp;
    private Date modificationTimestamp;
    private final String recordId = "102";
    /* ... */
}

 

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

문자 하나를 사용하는 이름과 상수는 텍스트 코드에서 쉽게 눈에 띄지 않는다.

 

//
for (int j=0; j<34; j++){
    s += (t[j]*4)/5;
}

//
int realDaysPerIdealDay = 4;
const int WORK_DAYS_PER_WEEK = 5;
int sum = 0;
for (int j =0; j< NUMBER_OF_TASKS; j++){
    int realTaskDays = taskEstimate[j] * realDaysPerIdealDay;
    int realTaskWeeks = (realTaskDays / WORK_DAYS_PER_WEEK);
    sum + realTaskWeek;
}

 

위 코드에서 WORK_DAYS_PER_WEEK는 찾기 쉽지만, 그냥 5를 사용하면

5가 들어가는 이름을 모두 찾은 후 의미까지 분석을 해야한다.

(realDaysPerIdealDay도 마찬가지..)

 

인코딩을 피하라

 

· 헝가리식 표기법 : 변수나 함수의 이름에 데이터 타입 따위를 명시하는 표기법

 

자바 프로그래머는 변수 이름에 타입을 인코딩할 필요가 없다.

IDE는 코드를 컴파일하지 않고도 타입 오류를 감지할 정도로 발전했다.

따라서 헝가리식 표기법이나 기타 인코딩 방식이 오히려 방해가 될 뿐이다.

 

 

· 멤버 변수 접두어

 

멤버 변수에 m_이라는 접두어를 붙이지 마라.

클래스와 함수는 접두어가 필요없을 정도로 작아야하고,

멤버 변수를 다른 색상으로 표시하거나 눈에 띄게 보여주는 IDE를 사용해야한다.

 

 

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

 

인터페이스 이름은 접두어 I를 붙이지 말자.

IShapeFactory보다 구현클래스를 ShapeFactoryImp로 명명하는 편이 좋다.

 

 

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

똑똑한 프로그래머와 전문가 프로그래머 사이의 차이점은 전문가 프로그래머는 '명료함이 최고'라는 사실을 이해한다.

 

독자가 코드를 읽으면서 변수 이름을 자신이 아는 이름으로 변환해야 한다면 이 변수 이름은 바람직하지 않다.

또한, 루프에서 반복 횟수를 세는 변수 i, j, k는 괜찮다. (l은 절대 안됨)

단, 루프 범위가 작고 다른 이름과 충돌하지 않을 때만 괜찮다.

 

 

클래스 이름

클래스 이름과 객체 이름은 명사나 명사구가 적합하다.

Manager, Processor, Data, Info와 같은 단어와 동사는 피하는 것이 좋다.

 

 

메서드 이름

메서드 이름은 동사나 동사구가 적합하다.

접근자, 변경자, 조건자는 javabean 표준에 따라 값 앞에 get, set, is를 붙인다.

 

 

기발한 이름은 피하라

재미난 이름보다 명료한 이름을 선택하는 것이 좋다.

HolyHandGrrenade보다 DeleteItems가 더 좋은 함수 이름이다.

 

*HolyHandGemade는 <몬티 파이썬>에 나오는 가상의 무기라고 하네요..

 

 

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

추상적인 개념 하나에 단어 하나를 선택해 이를 고수한다.

예를 들어, 똑같은 메서드를 클래스마다 fetch, retrieve, get으로 제각각 부르면 혼란을 유발한다.

(controller, manager, driver 또한 마찬가지다.)

최신 IDE는 객체를 사용하면 그 객체가 제공하는 메서드 목록을 보여준다.

하지만 함수 이름과 매개변수만 보여줄 뿐 주석을 보여주지 않기 때문에

메서드 이름은 독자적이고 일관적이여야 한다.

 

 

말장난을 하지마라

한 단어를 두가지 목적으로 사용하지 마라. 다른 개념에 같은 단어를 사용하지 말라는 뜻이다.

위에서 "한 개념에 한 단어를 사용하라"라는 규칙을 따랐더니 add라는 메서드가 생겼다.

모든 add 메서드의 매개변수와 반환값이 의미적으로 동일하다면 문제가 없다.

하지만 같은 맥락이 아님에도 일관성을 고려하여 add라는 단어를 선택한다.

 

add메서드는 모두가 기존 값 두개를 더하거나 이어서 새로운 값을 만든다고 가정하고,

새로 작성하는 메서드는 집한에 값 하나를 추가하는 것이라면...

이 메서드는 add아 맥락이 다르다.

insert나 append라는 이름이 적당할 것이다.

 

 

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

코드를 읽을 사람도 프로그래머라는 사실을 명심하자.

그러므로 전산 용어, 알고리즘 이름, 패턴이름, 수학 용어를 사용해도 괜찮다.

 

 

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

적절한 프로그래머 용어가 없다면 문제 영역에서 이름을 가져온다.

문제 영역 개념과 관련이 깊은 코드라면 문제 영역에서 이름을 가져와야 한다.

 

 

의미 있는 맥락을 추가하라

스스로 의미가 분명한 이름이 없진 않지만, 대다수 이름은 그렇지 못하다.

그래서 클래스, 함수, 이름 공간에 넣어 맥락을 부여한다.

모든 방법이 실패하면 마지막 수단으로 접두어를 붙인다.

//맥락이 불분명한 변수
private void printGGuseeStatistics(char candidate, int count) {
    String number;
    String verb;
    String pluralModifier;
    
    /* ... */
}

//맥락이 분명한 변수 -> 세 변수는 확실하게 GuessStatisticsMessage에 속함
public classs GuessStatisicsMessage {
    private String number;
    private String verb;
    private String pluralModifier;
    
    /* ... */
}

 

 

불필요한 맥락을 없애라

Gas Station Deluxe라는 애플리케이션을 짠다고 가정했을 때,

모든 클래스 이름을 GSD로 시작하는 것은 바람직하지 못하다.

 

accountAddress와 customerAddress는 Adress 클래스 인스턴스로는 좋은 이름이나,

클래스 이름으로는 적합하지 못하다. Address는 클래스 이름으로 적합하다.

 

일반적으로 짧은 이름이 긴 이름보다 좋다. (단, 의미가 분명한 경우에 한하여)