프로그래밍과 영어

void printOwing(double amount) 
{
  printBanner();

  /* print details */ 
  System.out.println("name:" + _name);
  System.out.println("amount" + amount);
}

===>

void printOwing(double amount) 
{
  printBanner();

  printDetails(amount);
}

void printDetails(double amount) {
  System.out.println("name:" + _name);
  System.out.println("amount" + amount);
}

이 예는 코드의 블럭에 주석을 붙여서 설명을 하는 대신, 블럭이 하는 일을 직접 알 수 있는 이름의 메서드를 추가함으로써 주석 자체가 필요없게 만든 것이다. 그러나, 주석에 관련된 이러한 지침들과 조언들은 대부분 프로그래머가 영어에 익숙하다는 전제를 깔고 있다. 아주 극단적인 예로, 다음 두 코드 조각들을 비교해보자.

1.

void printOwing(double amount) 
{
  printBanner();

  printDetails(amount);
}

2.

/* 고객의 미지불 정보를 출력. a는 미지불 총액 */ 
void print1(double a) 
{
  /* 배너를 출력한다 */ 
    print2();

  /* 미지불 정보를 출력한다. */ 
  print3(a);
}

영어에 익숙한 사람이라면 당연히 1번 예가 더 낫다고 생각할 것이며, 주석을 달 필요를 전혀 못느낄 것이다. 그러나 만일 owing이나 banner, amount 같은 단어를 모르는 사람이라면 1번은 주석이 전혀 없는 난해한 코드, 2번은 친절한 주석이 달린 알기 쉬운 코드라고 생각할 수 있다.

int getCurrentDistanceFromOrigin(int aX, aY)
{
  return getDistanceBetween( 
    Position(theOriginX, theOriginY), Position(aX, aY) 
  );
}

class Apple
{
private:
  Color theColor;
public:
  void setColor(Color aColor) { theColor = aColor; }
};

...

Apple aApple;
aApple.setColor( Color("Red") );

void move(int aSpeed)
{
...
}
...

move(MOVING_SPEED_FAST);

또는, 
class Ship 
{
...
  int theSpeed;
...
  void setSpeed(int aSpeed) { .... }
...
};

aShip.setSpeed(MOVING_SPEED_FAST); 
aShip.move();

void Ship::moveFast()
{
  setSpeed(MOVING_SPEED_FAST); 
  move();
}

Apple aRedApple;
aRedApple.setColor(“Red");

bool IsAppleRed(Apple& anApple)
{
  return ( anApple.getColor() == "Red" );
}