[Clean Code #7] 5. 형식 맞추기

프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다.
코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다.
팀으로 일한다면 팀이 합의해 규칙을 정하고 모두가 그 규칙을 따라야 한다.
필요하다면 규칙을 자동으로 적용하는 도구를 활용한다.

형식을 맞추는 목적

코드 형식은 중요하다!

너무나도 중요하므로 융통성 없이 맹목적으로 따르면 안 된다. 코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다.

오늘 구현한 기능이 다음 버전에서 바뀔 확률은 아주 높다. 그런데 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.

코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.

원래 코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.

원활한 소통을 장려하는 코드 형식

적절한 행 길이를 유지하라

상자는 평균 위/아래로 (표준편차/2)를 나타낸다. 파일 길이가 정규 분포는 아니므로 표준 편차가 수학적으로 정확하지 않다는 사실은 충분히 안다.

표 5-1를 통해 500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다는 사실을 알 수 있다

반드시 지킬 엄격한 규칙은 아니지만 바람직한 규칙으로 삼으면 좋겠다. 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.

신문 기사처럼 작성하라

이름은 간단하면서도 설명이 가능하게 짓는다. 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다.

소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다. 마지막에는 가장 저차원 함수와 세부 내역이 나온다.

개념은 빈 행으로 분리하라

생각 사이는 빈 행을 넣어 분리해야 마땅하다. 너무도 간단한 규칙이지만 코드의 세로 레이아웃에 심오한 영향을 미친다.

빈 행은 새로운 개념을 시작한다는 시각적 단서다. 코드를 읽어 내려가다 보면 빈 행 바로 다음 줄에 눈길이 멈춘다.

빈 행을 빼버리면, 코드 가독성이 현저하게 떨어진다.

세로 밀집도

줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다.

즉, 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다.

public class ReporterConfig { 
  /**
  * 리포터 리스너의 클래스 이름
  */
  private String m_className;
  /**
  * 리포터 리스너의 속성 */
  private List<Property> m_properties = new ArrayList<Property>(); 
  public void addProperty(Property property) {
  m_properties.add(property); 
}

→ Before

public class ReporterConfig {
  private String m_className;
  private List<Property> m_properties = new ArrayList<Property>();
  public void addProperty(Property property) { 
  m_properties.add(property);
  } 
}

→ After

수직 거리

서로 밀접한 개념은 세로로 가까이 둬야 한다. 물론 두 개념이 서로 다른 파일에 속한다면 규칙이 통하지 않는다. 하지만 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 마땅하다.

이게 바로 protected 변수를 피해야 하는 이유 중 하나다.

같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다.
여기서 연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도다. 연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다.

1. 변수 선언

• 변수는 사용하는 위치에 최대한 가까이 선언한다.루프를 제어하는 변수는 흔히 루프 문 내부에 선언한다.다소 긴 함수에서 블록 상단이나 루프 직전에 변수를 선언하는 사례도 있다.
  
  

2. 인스턴스 변수

• 인스턴스 변수는 클래스 맨 처음에 선언한다. 잘 설계한 클래스는 많은 (혹은 대다수) 클래스 메서 드가 인스턴스 변수를 사용하기 때문이다.

• 인스턴스 변수를 선언하는 위치는 아직도 논쟁이 분분하다. 다만 잘 알려진 위치에 인스턴스 변수를 모은다는 사실이 중요하다.
  - C++ → 클래스 맨 마지막 (가위 규칙)
  - Java → 클래스 맨 처음
  
  

3. 종속 함수

• 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.

• 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다.

• 규칙을 일관적으로 적용한다면 독자는 방금 호출한 함수가 잠시 후에 정의되리라는 사실을 예측한다

• 호출되는 함수를 찾기가 쉬워지며, 그만큼 모듈 전체의 가독성도 높아진다.

• 상수를 알아야 마땅한 함수에서 실제로 사용하는 함수로 상수를 넘겨주는 방법이 더 좋다.
  
  

4. 개념적 유사성

• 친화도가 높을수록 코드를 가까이 배치한다.

• 친화도가 높은 요인

  • 한 함수가 다른 함수를 호출해 생기는 직접적인 종속성

  • 변수와 그 변수를 사용하는 함수

  • 종속적인 관계가 없더라도, 명명법이 똑같고 기본 기능이 유사하고 간단하다.

    static public void assertTrue(boolean condition) {
    assertTrue(null, condition);
    }
    static public void assertFalse(String message, boolean condition) {
     assertTrue(message, !condition);
    }
    static public void assertFalse(boolean condition) {
     assertFalse(null, condition);
    }

세로 순서

일반적으로 함수 호출 종속성은 아래 방향으로 유지한다. 다시 말해, 호출되는 함수를 호출하는 함수보다 나중에 배치한다.

이로써 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.

• 가장 중요한 개념을 가장 먼저 표현한다.
• 가장 중요한 개념을 표현할 때는 세세한 사항을 최대한 배제한다.
• 세세한 사항은 가장 마지막에 표현한다.

→ 소스 파일에서 첫 함수 몇 개만 읽어도 개념을 파악하기 쉬워진다.

가로 형식 맞추기

프로그래머는 명백하게 짧은 행을 선호한다. 그러므로 짧은 행이 바람직하다.

개인적으로는 120자 정도로 행 길이를 제한한다. 하지만 그 이상은 솔직히 주의부족이다.

가로 공백과 밀집도

가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.

• 할당문은 왼쪽 요소와 오른쪽 요소가 분명히 나뉜다.
  • 할당문 : = (equal)

  		int lineSize = line.length();

• 공백을 넣으면 두 가지 주요 요소가 확실히 나뉜다는 사실이 더욱 분명해진다.

• 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않았다.

  • 함수와 인수는 서로 밀접하기 때문이다. 공백을 넣으면 한 개념이 아니라 별개로 보인다.

• 연산자 우선순위를 강조하기 위해서도 공백을 사용한다.

public class Quadratic {
  public static double root1(double a, double b, double c) {
    double determinant = determinant(a, b, c);
      return (-b + Math.sqrt(determinant)) / (2*a); 
    }
  
    public static double root2(int a, int b, int c) { 
      double determinant = determinant(a, b, c); 
      return (-b - Math.sqrt(determinant)) / (2*a);
    }
    private static double determinant(double a, double b, double c) {
      return b*b - 4*a*c; 
    }
}

가로 정렬

위와 같은 정렬은 별로 유용하지 못하다. 코드가 엉뚱한 부분을 강조해 진짜 의도가 가려지기 때문이다.

정렬하지 않으면 오히려 중대한 결함을 찾기 쉽다.

정렬이 필요할 정도로 목록이 길다면 문제는 목록 길이지 정렬 부족이 아니다.

선언부가 길다면 클래스를 쪼개야 한다는 의미다.

들여쓰기

계층에서 각 수준은 이름을 선언하는 범위이자 선언문과 실행문을 해석하는 범위다.

범위(scope)로 이뤄진 계층을 표현하기 위해 우리는 코드를 들여쓴다.

들여쓰는 정도는 계층에서 코드가 자리잡은 수준에 비례한다.

• 클래스 정의처럼 파일 수준인 문장은 들여쓰지 않는다.
• 클래스 내 메서드는 클래스보다 한 수준 들여쓴다.
• 메서드 코드는 메서드 선언보다 한 수준 들여쓴다.
• 블록 코드는 블록을 포함하는 코드보다 한 수준 들여쓴다.

프로그래머는 왼쪽으로 코드를 맞춰 코드가 속하는 범위를 시각적으로 표현한다. 그러면 이 범위에서 저 범위로 재빨리 이동하기 쉬워진다.

들여쓰기 무시하기

간단한 if 문, 짧은 while 문, 짧은 함수에서 들여쓰기 무시하지 않기.

public class CommentWidget extends TextWidget {
  public static final String REGEXP = "^#[^\r\n]*(?:(?:\r\n)|\n|\r)?";
  
  public CommentWidget(ParentWidget parent, String text){super(parent, text);}
  public String render() throws Exception {return ""; } 
}

public class CommentWidget extends TextWidget {
  public static final String REGEXP = "^#[^\r\n]*(?:(?:\r\n)|\n|\r)?";
  
  public CommentWidget(ParentWidget parent, String text) { 
    super(parent, text);
  }
  
  public String render() throws Exception{ 
    return "";
  } 
}

가짜 범위

빈 while문이나 for문을 피하지 못할 때는 빈 블록을 올바로 들여쓰고 괄호로 감싼다.

세미콜론(;)은 새 행에다 제대로 들여써서 넣어준다.

while (dis.read(buf, 0, readBufferSize) != -1) 
;

팀 규칙

프로그래머라면 각자 선호하는 규칙이 있다. 하지만 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.

팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다. 그래야 소프트웨어가 일관적인 스타일을 보인다.

우리가 정한 규칙으로 IDE 코드 형식기를 설정한 후 지금까지 사용했다.

좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하기 바란다. 스타일은 일관적이고 매끄러워야 한다.

한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다.