[Clean Code] 5. 형식 맞추기

 

형식을 맞추는 목적

코드 형식은 중요하다! 코드 형식은 의사소통의 일환이다. 오늘 구현한 기능이 다음 버전에서 바뀐다 하더라도 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.

 

적절한 행 길이를 유지하라

대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다. 반드시 지킬 엄격한 규칙은 아니지만 바람직한 규칙으로 삼으면 좋겠다. 큰 파일보다 작은 파일이 이해하기 쉽다.

 

<신문 기사처럼 작성하라>

신문 기사를 떠올려 보자. 최상단에 기사를 몇 마디로 요약하는 표제가 나온다. 첫 문단은 전체 기사 내용을 요약한다. 쭉 읽으며 내려가면 세세한 사실이 조금씩 드러난다.

소스 파일도 신문 기사와 비슷하게 작성한다. 이름은 간단하면서도 설명이 가능하게 짓는다. 소스 파일 첫 부분은 고차원 개념을, 아래로 내려갈수록 의도를 세세하게 묘사한다.

 

<개념은 빈 행으로 분리하라>

일련의 행 묶음은 완결된 생각 하나를 표현한다. 생각 사이는 빈 행을 넣어 분리해야 마땅하다. import문, 각 함수 사이에는 빈 행이 들어간다. 너무도 간단한 규칙이지만 빈 행은 새로운 개념을 시작한다는 시각적 단서다.

 

<세로 밀집도>

줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다. 즉, 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다는 뜻이다. 보통 한 클래스에서 변수들은 붙여 놓고 메서드가 등장하는 순간부터는 줄바꿈한다.

 

<수직 거리>

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

- 변수 선언, 변수는 사용하는 위치에 최대한 가까이 선언한다.

- 인스턴스 변수, 인스턴스 변수는 클래스 맨 처음에 선언한다.

- 종속 함수, 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 호출하는 함수를 호출되는 함수보다 먼저 배치하면 좋다.

- 개념적 유사성, 친화도가 높을수록 코드를 가까이 배치한다. 친화도가 높은 요인은 여러 가지다. 앞서 보았듯이, 함수가 다른 함수를 호출하는 경우가 한 예다. 또한 비슷한 동작을 수행하는 일군의 함수 역시 좋은 예다. 다음은 JUnit 4.3.1에서 가져온 코드다.

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);
    }
    ...

 

<세로 순서>

일반적으로 함수 호출 종속성은 아래 방향으로 유지한다. 호출되는 함수를 호출하는 함수보다 나중에 배치하는 것이다. 신문 기사와 마찬가지로 가장 중요한 개념을 가장 먼저 표현한다. 세세한 사항은 최대한 배제한다.

 

가로 형식 맞추기

프로그래머는 짧은 행을 선호한다. 개인적으로는 120자 정도로 행 길이를 제한한다.

 

<가로 공백과 밀집도>

가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다. 다음 함수를 살펴보자.

public static double root(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;
}

할당 연산자(=)를 강조하려고 앞뒤에 공백을 줬다. 양 쪽 요소가 확실히 나뉜다는 사실이 더욱 분명해진다.

반면, 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않았다. 함수와 인수는 서로 밀접하기 때문이다.

또한, 연산자 우선순위를 강조하기 위해서도 공백을 사용한다. 승수 사이에는 공백이 없다. 곱셈은 우선순위가 가장 높기 때문이다. 항 사이에는 공백이 들어간다. 덧셈과 뺄셈은 우선순위가 곱셈보다 낮기 때문이다. 그러나 코드 형식을 자동으로 맞춰주는 도구는 대다수가 연산자 우선순위를 고려하지 못하므로, 수식에 똑같은 간격을 적용한다.

 

<가로 정렬>

특정 구조를 강조하고자 가로 정렬을 사용하는 경우를 보자.

private    Socket          socket;
private    InputStream     input;
private    OutputStream    output;

하지만 이런 정렬은 별로 유용하지 못하다. 위 변수를 읽다보면 변수 유형은 무시하고 변수 이름부터 읽게 된다. 게다가, 코드 형식을 자동으로 맞춰주는 도구는 대다수가 위와 같은 정렬을 무시한다.

 

<들여쓰기>

파일, 클래스, 메서드, 블록처럼 범위로 이뤄진 계층을 표현하기 위해 우리는 코드를 들여쓴다. 들여쓰기한 파일은 구조가 한눈에 들어온다.

- 들여쓰기 무시하기, 때로는 간단한 함수에서 들여쓰기 규칙을 무시하곤 한다. 그러나 들어쓰기로 범위를 제대로 표현한 코드를 선호한다.

 

<가짜 범위>

때로는 빈 while 문이나 for 문을 접한다. 지금까지는 while 문 끝에 세미콜론 하나를 살짝 덧붙인 코드로 수없이 골탕을 먹었다. 세미콜론은 새 행에다 제대로 들여써서 넣어준다.

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

 

팀 규칙

팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다. 한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다.