5장. 형식 맞추기

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

형식을 맞추는 목적

코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다. 오늘 구현한 기능이 다음 버전에서 바뀔 확률은 아주 높으나, 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.
오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확정성에 계속 영향을 미친다.

적절한 행 길이를 유지하라

위 그림에서 보면 JUnit, FitNesse, Time and Money는 상대적으로 파일 크기가 작다. 500줄을 넘어가는 파일이 없으며 대다수가 200줄 미만이다. 반면, Tomcat과 Ant는 절반 이상이 200줄을 넘어서고 심지어 수천 줄이 넘어가는 파일도 있다.
이는 500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다는 사실을 보여준다. 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.

신문 기사처럼 작성하라

신문기사는 최상단에 기사를 몇 마디로 요약하는 표제가 나오며, 첫 문단은 전체 기사 내용을 요약한다. 세세한 사실은 숨기고 커다란 그림을 보여준다. 쭉 읽으며 내려가면 세세한 사실이 조금씩 드러난다. 소스 파일도 신문 기사와 유사하게 작성한다.

• 이름 : 간단하면서도 설명이 가능하게, 이름만 보고도 올바른 모듈을 살펴보고있는지 여부가 판단 가능할 정도로
• 소스 파일 첫 부분 : 고차원 개념과 알고리즘 설명
• 아래로 내려갈수록 의도 세세하게 묘사
• 마지막 : 가장 저차원 삼수와 세부 내역

개념은 빈 행으로 분리하라

각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다. 생각 사이는 빈 행을 넣어 분리해야 마땅하다.
빈 행은 새로운 개념을 시작한다는 시각적 단서다.
줄바꿈을 통해 행 묶음이 분리되어 보일수 있도록 하는 효과가 있다.

세로 밀집도

줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다. 즉, 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다는 뜻이다. 아래의 예제 역시 5-4가 훨씬 읽기 쉽다.

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

//5-4/ReporterConfig.java/리팩토링
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 변수를 피해야 하는 이유 중 하나다.
같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다. 여기서 연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도다. 연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다.

• 변수선언 : 변수는 사용하는 위치에 최대한 가까이 선언한다.
  • 지역 변수 : 각 함수 맨 처음에 선언
  • 루프를 제어하는 변수 : 루프문 내부에 선언
  • 드물게 다소 긴 함수에서 블록 상단이나 루프 직전에 변수를 선언하는 사례도 있다.
• 인스턴스 변수 : 클래스 맨 처음에 선언한다.
  변수간에 세로로 거리를 두지 않는다. 잘 설계한 클래스는 많은 클래스 메서드가 인스턴스 변수를 사용하기 때문이다.
• 종속 함수 : 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치하여 프로그램이 자연스럽게 읽히도록 한다.
• 개념적 유사성 : 친화도가 높을수록 코드를 가까이 배치한다.
  • 한 함수가 다른 삼수를 호출해 생기는 직접적인 종속성
  • 변수와 그 변수를 사용하는 함수
  • 비슷한 동작을 수행하는 일군의 함수

  public class Assert {
  	static public void assertTrue(String message, boolean condition) {
    	if(!condition)
        	fail(message);
    }
    
    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);
    }
  }

  이 함수들은 개념적인 친화도가 매우 높다. 명명법ㅇ치 똑같고 기본 기능이 유사하고 간단하다. 종속적인 관계가 없더라도 가까이 배치할 함수들이다.
  

세로 순서

일반적으로 함수 호출 종속성은 아래 방향으로 유지한다. 다시 말해, 호출되는 함수를 호출하는 함수보다 나중에 배치한다. 그러면 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.

가로 형식 맞추기

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

가로 공백과 밀집도

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

private void measureLine(String line) {
	lineCount++;
    int lineSize = line.length(); 						//할당 연산자 강조를 위해 앞뒤에 공백 부여
    totalChars += lineSize;								//할당 연산자 강조를 위해 앞뒤에 공백 부여
    lineWidthHistogram.addLine(lineSize, lineCount); 	//함수와 인수 사이는 밀접하므로 공백X
    recordWidestLine(lineSize);
}

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

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);
    }
    private static determinant(double a, double b, double c) {
    	return b*b - 4*a*c;
    }
}

가로 정렬

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

선언문과 할당문을 별도로 정렬하지 않으면 오히려 중대한 결함을 찾기 쉽다. 정렬이 필요할 정도로 목록이 길다면 문제는 목록 길이지 정렬 부족이 아니다. 코드에서 선언부가 길다면 클래스를 쪼개야 한다는 의미다.

들여쓰기

소스 파일은 윤곽도와 계층이 비슷하다. 아래의 항목들로 구성되어있다.

• 파일 전체에 적용되는 정보
• 파일 내 개별 클래스에 적용되는 정보
• 클래스 내 각 메서드에 적용되는 정보
• 블록 내 블록에 재귀적으로 적용되는 정보

계층에서 각 수준은 이름을 선언하는 범위이자 선언문과 실행문을 해석하는 범위다.
이렇듯 범위로 이뤄진 계층을 표현하기위해 우리는 코드를 들여쓴다. 들여쓰기한 파일은 구조가 한눈에 들어오며, 변수, 생성자 함수, 접근자 함수, 메서드가 금방 보인다.

가짜 범위

때로는 빈 while이나 for문을 접하는데, 피하지 못할 때는 빈 블록을 올바로 들여쓰고 괄호로 감싼다. 세미콜론은 새 행에다 제대로 들여써서 넣어주지 않으면 눈에 띄지 않는다.

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

팀 규칙

프로그래머라면 각자 선호하는 규칙이 있으나, 팀에 속한다면 자신이 선호해야할 규칙은 바로 팀 규칙이다. 팀은 한가지 규칙에 합의해야하며, 모든 팀원은 그 규칙을 따라야 한다. 그래야 소프트웨어가 일관적인 스타일을 보인다.