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

의도를 분명하게 밝혀라

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

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

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

 

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

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

3. 값 4는 무슨 의미인가?

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

 

지뢰찾기 게임이었다면, 

 

1. 게임판의 각 칸은 단순 배열

2. 칸 상태

3. 깃발이 꽂힌 상태

이렇게 각 개념에 이름만 붙여도, 코드의 단순성은 변하지 않았고 함수가 하는 일을 이해하기 쉬워졌다. 바로 이것이 좋은 이름이 주는 위력이다.

 

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

 

한 걸음 더 나아가, int 배열을 사용하는 대신, 칸을 간단한 클래스로 만들어도 되겠다.

isFlagged 라는 좀 더 명시적인 함수를 사용해 FLAGGED라는 상수를 감춰도 좋다.

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

바로 이것이 좋은 이름이 주는 위력이다.

 

작명시 주의할 점

- 훌륭한 약어로 보일지라도 특수한 의미로 읽힐 수 있는 단어는 변수명으로 피하라. 프로그래머에게 그릇된 정보를 제공하는 셈이다.

ex) hp, aix, sco : 유닉스 플랫폼이나 유닉스 변종을 가리키는 이름

ex) list -> accountGroup, bunchOfAccounts 로 고쳐라!

 

- 겁나게 비슷한 이름, 흡사한 이름은 사용하지 마라!

ex) A모듈에서 XYZControllerForEfficientHandlingOfString,

B모듈에서 XYZControllerForEfficientStorageOfString 차이를 어떻게 알아채는가?

 

- 알파벳 한글자 약어는 제발 변수명으로 쓰지 마라

ex) O, L, l 

 

- 읽는 사람이 차이를 알도록 이름을 지어라

ex) getAtiveAccount();

getAtiveAccounts();

getAtiveAccountInfo();

이 프로젝트에 참여한 프로그래머는 어느 함수를 호출할지 어떻게 아는가?

 

- 접두어는 옛날에 작성한 구닥다리 코드라는 징표이다.

ex) m_dsc

 

- 클래스 이름과 깨체 이름은 명사나 명사구가 적합하다. 메서드 이름은 동사나 동사구가 적합하다.

 

- 명료한 이름이 최고다. 언어 유희, 농담은 피하라. 말장난을 하지마라.

 

- 이름에 불필요한 맥락을 추가하지 않도록 주의한다.

 

의미있는 맥락을 추가하라

아래 코드는 그냥 메서드만 훑어서는 세 변수의 의미가 불분명하다. 

private void printGuseeStaatistics(char candidate, int count) {
	String number;
	String verb;
	String pluralModifier;
	if(count == 0){
		number = "no";
		verb = "are";
		pluralModifier = "s"
	} else if(count == 1) {
		number = "1";
		verb = "is";
		pluralModifier = ""
	} else {
		number = Integer.toString(count);
		verb = "are";
		pluralModifier = "s"
	}
	String guessMessage = String.format(
		"There %s %s %s %s", verb, number, candidate, pluralModifier
	);
	print(guessMessage);
}

일단 함수가 좀 길다. 그리고 세 변수를 함수 전반에서 사용한다.

함수를 작은 조각으로 쪼개고자 GuessStatisticsMessage 라는 클래스를 만든 후 세 변수를 클래스에 넣어라.

그러면 세 변수는 맥락이 분명해진다. (즉, 세 변수는 확실하게 GuessStatisticsMessage에 속한다.)

이렇게 맥락을 개선하면 함수를 쪼개기가 쉬워지므로 알고리즘도 좀 더 명확해진다.

 

public class GuessStatisticsMessage {
	private String number;
	private String verb;
	private String pluralModifier;

	public String make(char candidate, int count){
		createPluralDependenMessageParts(count);
		return String.format(
			"There %s %s %s %s",
			verb, number, candidate, pluralModifier
		);
	}

}

private void printGuseeStaatistics(int count) {
	if (count == 0) {
		thereAreNoLetters(0);
	} else if (count == 1) {
		thereIsOneLetter(0);
	} else {
		thereAreManyLetters(0);
	}
}

private void thereAreNoLetters(){
	number = "no";
	verb = "are";
	pluralModifier = "s"
}

private void thereIsOneLetter(){
	number = "1";
	verb = "is";
	pluralModifier = ""
}

private void thereAreManyLetters(int count){
	number = Integer.toString(count);
	verb = "are";
	pluralModifier = "s"
}