2장은 의미있는 이름에 대해 이야기를 하고 있다. 우리는 변수, 함수, 인수, 클래스, 패키지, 소스파일, 디렉토리, war, jar 등등 많은 곳에 이름을 붙이고 있는데 이 이름을 잘 지으면 여러모로 편하다는 것과 몇가지 규칙을 소개하고 있다.

의도를 분명하게 밝히자

• 의도가 분명한 이름을 지으면 절약하는 시간이 많아질 것이고 자신을 포함한 코드를 읽는 사람이 행복해질 것이라고 말하고 있다.

• 변수, 함수, 클래스 등의 이름은 다음과 같은 질문에 모두 답할 수 있어야 한다.

  • 존재 이유
  • 수행 기능
  • 사용 방법

  따로 주석이 필요하다면? 의도를 분명히 드러내지 못한 것이다.

의도가 분명하지 않은 코드란?(1)

int a;
int b;
String age = "김형욱";

의도가 분명한 코드란?(1)

int elapsedTimeDays;
int daysSinceCreation;
int daysSinceModification;
int fileAgeInDays

의도가 분명하지 않은 코드란?(2)

• 코드 맥락이 코드 자체에 명시적으로 드러나지 않는다. 이 코드는 코드를 읽는 사람이 다음과 같은 정보를 안다고 가정해야지 코드의 의도를 파악할 수 있다.

  • theList에 무엇이 들어있는가?
  • theList에서 0번째 값이 어째서 중요한가?
  • 값 4는 무슨 의미인가?
  • 함수가 반환하는 리스트에 list1을 어떻게 사용하는가?

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

의도가 분명한 코드란?(2)

• 코드의 단순성은 달라지지 않았지만 의미가 명확해진 모습을 확인할 수 있다.

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

그릇된 정보를 피하라