Prologue

프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다. 코드 형식을 맞추기 위해 간단한 규칙을 정하고 그 규칙을 따라야 한다. 팀으로 일한다면 팀이 합의해 규칙을 정하고 모두가 따라야 한다.

Subject

형식을 맞추는 목적

  • 코드 형식은 중요하다. 너무나도 중요하므로 융통성 없이 맹목적으로 따르면 안된다.
  • 코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다.
  • 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다. 오랜 시간이 지나 원래 코드의 흔적을 찾아보기 어려울 정도로 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다. 원래 코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.

적절한 행 길이를 유지하라

  • 500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다.(책의 그림 5.1 참고!)
  • 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.

[신문 기사처럼 작성하라]

  • 이름은 간단하면서도 설명이 가능하게 짓는다.
  • 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다.
  • 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다.
  • 마지막에는 가장 저차원 함수와 세부 내역이 나온다.
  • 신문의 대다수 기사는 아주 짧다. 어떤 기사는 조금 길더라도 한 면을 채우는 기사는 없다. 이게 신문이 읽을만한 이유이다.

[개념은 빈 행으로 분리하라]

  • 거의 모든 코드는 왼쪽에서 오른쪽으로 그리고 위에서 아래로 읽힌다.
  • 각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다.
  • 생각 사이는 빈 행을 넣어 분리해야 마땅하다.
  • 일반적으로 패키지 선언부, import문, 각 함수 사이에 빈 행이 들어간다. 너무도 간단한 규칙이지만, 코드의 세로 레이아웃에 심오한 영향을 미친다. 빈 행은 새로운 개념을 시작한다는 시각적 단서다. 코드를 읽어 내려가다 보면 빈 행 바로 다음 줄에 눈길이 멈춘다.
  • 빈 행을 빼면 코드가 암호처럼 보인다.

[세로 밀집도]

  • 줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다.
  • 즉, 서로 밀접한 코드 행은 세로로 가까이에 놓여야 한다는 뜻이다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
public class ReporterConfig{
    /**
    * 리포터 리스너의 클래스 이름.
    */
    private String m_className;
    
    /**
    * 리포터 리스너의 속성.
    */
    private List<Property> m_properties = new ArrayList<Property>();
    public void addProperty(Property property){
        m_properties.add(property);
    }
}
  • 위의 코드는 주석으로 두 인스턴스 변수를 떨어트려 놓았다. 이로 인해 머리와 눈을 더 움직여야 한다.
1
2
3
4
5
6
7
public class ReporterConfig{
    private String m_className;
    private List<Property> m_properties = new ArrayList<Property>();
    public void addProperty(Property property){
        m_properties.add(property);
    }
}
  • 위의 코드가 훨씬 읽기 쉽다. 코드가 한눈에 들어온다.
  • 머리나 눈을 움직일 필요가 거의 없다.

[수직 거리]

  • 시스템이 무엇을 하는지 이해하고 싶은데, 이 조각 저 조각이 어디에 있는지 찾고 기억하느라 시간과 노력을 소모한다.
  • 서로 밀접한 개념은 세로로 가까이 둬야 한다는 규칙을 보았다. 물론 두 개념이 서로 다른 파일에 속한다면 규칙이 통하지 않는다. 하지만, 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 마땅하다.
  • 이게 바로 protected 변수를 피해야 하는 이유 중 하나이다.
  • 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다.
  • 연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도이다. 연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 되어 번거롭다.
  1. 변수 선언
  • 변수는 사용하는 위치에 최대한 가까이 선언한다.
  • 루프를 제어하는 변수는 흔히 루프 문 내부에 선언한다.
  1. 인스턴스 변수
  • 인스턴스 변수는 클래스 맨 처음에 선언한다.
  • 변수 간에 세로로 거리를 두지 않는다.
  • 잘 설계한 클래스는 많은 클래스 메소드가 인스턴스 변수를 사용하기 때문이다.
  • 변수 선언을 어디서 찾을지 모두가 알고 있어야 한다.
  1. 종속 함수
  • 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
  • 또한, 가능하다면 호출하는 함수를 호출ㄷ괴는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다.
  • 규칙을 일관적으로 적용한다면 독자는 방금 호출한 함수가 잠시 후에 정의되리라는 사실을 예측한다. 이를 통해 호출되는 함수를 찾기가 쉬워지며, 모듈 전체의 가독성도 높아진다.
  1. 개념적 유사성