[클린 코드] 5장: 형식 맞추기

 프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다. 코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 따라야 한다. 

 

형식을 맞추는 목적

코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다. 

오늘 구현한 기능이 다음 버전에서 바뀔 확률은 아주 높다. 그렇다면 오늘 구현한 코드의 가독성도 중요하지 않을까?

코드의 내용 뿐만 아니라 코드 그 자체도 유지보수에 영향을 미친다.

 

적절한 행 길이를 유지하라

200줄이 넘어가지 않는 파일들로도 커다란 시스템을 구축할 수 있다. 항상 그런 것은 아니지만, 가급적 작은 파일이 큰 파일보다 이해하기 쉽다.

 

• 신문 기사처럼 작성하라

좋은 신문 기사의 특징이 무엇일까? 위에서 아래로 추상화 수준이 낮아진다. 즉, 처음에는 커다란 주제를 던져주고 아래로 내려갈수록 세세한 내용을 언급한다. 좋은 소스 파일도 신문과 비슷해야 한다.

 

• 개념은 빈 행으로 분리하라

거의 모든 코드는 왼쪽에서 오른쪽으로, 그리고 위에서 아래로 읽힌다. 빈 행을 적극적으로 활용해라. 빈 행은 새로운 개념을 시작한다는 시각적 단서이다. 1번 코드와 2번 코드를 비교해보자. 2번 코드가 확실히 가독성 측면에서 좋다. 개념이 명확하게 분리된다.

// 1번
import java.util.*;
public class Test {
	private final int TEST_NUMBER = 1;
    public void testMethod() {
    	...
    }
}


// 2번
import java.util.*;

public class Test {
	private final int TEST_NUMBER = 1;
    
    public void testMethod() {
    	...
    }
}

 

• 세로 밀집도

줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다. 즉, 서로 밀접한 개념을 가진 코드는 세로로 가까이 놓아야 한다는 것이다.

public class Test {
    private final int TEST_ONE = 1;
    
    public void testMethod1() {
    	...
    }
    
    private final int TEST_TWO = 2;
    
    public void testMethod2() {
    	...
    }
}

위와 같은 경우 같은 '인스턴스 상수'라는 개념을 갖고 있지만, 세로로 밀집되어 있지 않다. 이런 경우를 피하자.

 

• 수직 거리

시스템이 무엇을 하는지 이해하고 싶은데, 이 조각 저 조각 어디에 있는지 찾고 기억하느라 시간과 노력을 소모한 경험이 있는가?

서로 밀접한 개념은 세로로 가까이 둬야 한다. 물론 두 개념이 같은 파일에 있다는 가정 한에서다. 하지만 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 마땅하다. 이것이 protected 변수를 피해야 하는 이유 중 하나이다.

 

여기서 연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도 이다. 

 

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

 

인스턴스 변수 : 인스턴스 변수는 클래스 맨 처음에 선언한다. 다만, 클래스 마지막에 선언하는 것을 고수하는 개발자도 많은데, 사실 어디에 선언되는지는 크게 중요하지 않다. 잘 알려진 위치에 인스턴스 변수를 모은다는 사실이 중요하다.

 

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

 

public Pizza makePizza() {
	makeDough();
	sauce();
	putInOven();
}

private void makeDough() {
	...
}

private void sauce() {
	...
}

private void putInOven() {
	...
}

 

개념적 유사성 : 개념적인 친화도가 높은 코드를 가까이 배치한다. 친화도가 높은 요인은 여러 가지지만, 대표적인 예시는 비슷한 동작을 수행하는 일군의 함수이다.

 

public class Test {
	...
    public void getX() {
    	...
    }
    
    public void getY() {
    	...
    }
    
    public void setX() {
    	...
    }
    
    public void setY() {
    	...
    }
}
// 개념적 유사성을 통해 Getter, Setter를 밀집시켰다.

 

• 세로 순서

일반적으로 함수 호출 종속성은 아래 방향으로 유지한다. 즉, 신문처럼 큰 개념을 먼저 배치하고, 세세하고 작은 개념들의 함수들은 나중에 배치한다. 고차원에서 저차원으로 자연스럽게 배치시킨다.

 

가로 형식 맞추기

한 행은 가로로 얼마나 길어야 적당할까? 답은 '짧을 수록 좋다' 이다.

100자나 120자가 되어도 괜찮다. 그러나 그 이상이 되면 주의부족이다.

 

• 가로 공백과 밀집도

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

아래 예시에서는 1. 할당 연산자는 왼쪽 요소와 오른쪽 요소가 분명히 나뉘므로 공백을 사용, 2. 함수 이름과 괄호 사이에는 밀접한 개념이기 때문에 공백 사용 X.

 

int lineSize = line.length(); // O
int lineSize=line.length(); // X
int lineSize = line.length (); // X

 

 

• 가로 정렬

다음과 같이 가로 정렬을 사용하지 않는다. 이렇게 작성하는 것은 오히려 진짜 문제가 무엇인지를 망각하게 만든다. 정렬이 필요할정도로 목록이 길다면 문제는 목록 '길이'이지, 정렬 부족이 아니다.

 

public class FitNesseExpediter {
    private   Socket         socket;
    private   InputStream    input;
    private   OutputStream   output;
    private   Request        request;
    ...
}

 

• 들여 쓰기

소스 파일에서는 클래스, 메소드, 블록 등 다양한 계층이 존재한다. 이렇게 범위로 이루어진 계층을 표현하기 위해서 우리는 들여쓰기를 사용한다. 들여쓰기를 습관화하자. 짧은 if 문이나 함수에서도 들여쓰기를 무시해서는 안된다. 다음과 같은 경우이다.

 

// X
if (isTest()) return true; 

// OK
if (istTest()) { 
	return true;
} 

// X
int testMethod() { return 1; } 

// O
int testMethod() {
	return 1;
}

 

• 가짜 범위

빈 while문이나 for문에서도 세미콜론 하나를 새 행에다 제대로 들여써서 넣어준다. 그렇게 하지 않으면 눈에 띄지 않는다.

 

// X
while(...);

// OK
while(...)
	;

 

팀 규칙

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

소프트웨어를 일관적으로 짜려고 노력하자. 개발자마다 다른 스타일을 적용해 소프트웨어를 만들어내서는 안된다.