5장 형식 맞추기
프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다. 코드 형식을 맞추기 위한 몇 가지 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다. 팀으로 일한다면 팀이 합의해 규칙을 정하고 모든 팀원이 그 규칙을 따라야 한다. 필요하다면 규칙을 자동으로 적용해주는 도구를 활용한다.
이 장에선느 원활한 소통을 장려하는 코드 형식에 대해 소개한다.
형식을 맞추는 목적
코드 형식은 중요하다! 코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다. 오늘 구현한 기능이 다음 버전에서 바뀔 확률은 아주 높다. 그렇기 때문에 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.
오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다. 원래 코드는 사라질지라도 개발자의 스타일과 규율운 사라지지 않는다.
적절한 행 길이를 유지하라
세로 길이부터 살펴보자. 소스 코드는 얼마나 길어야 적당할까? 자바에서 파일 크기는 클래스 크기와 밀접하다. 저자는 대표적인 오픈 소스 자바 프로젝트를 분석해서 적당한 라인 수는 어느 정도인지 설명한다.
결론은 대부분의 클래스는 500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다. 반드시 지킬 엄격한 규칙은 아니지만 바람직한 규칙으로 삼아야 한다. 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽기 때문이다.
신문 기사처럼 작성하라
신문을 읽은 때 독자는 위에서 아래로 기사를 읽는다. 최상단에 기사를 몇 마디로 요약하는 표제가 나온다. 독자는 표제를 보고서 기사를 읽을지 말지 결정한다. 첫 문단은 전체 기사 내용을 요약한다. 세세한 사실은 숨기고 커다란 그림을 보여준다. 쭉 읽으며 내려가면 세세한 사실이 조금씩 드러난다. 날짜, 이름, 발언, 주장, 기타 세부사항이 나온다. 신문 기사는 이러한 다양한 기사도 이뤄진다. 대다수 기사가 아주 짧다. 어떤 기사는 조금 길지만, 한 면을 채우는 기사는 거의 없다. 신문이 사실, 날짜 이름 등을 무작위로 뒤섞은 긴 기사 하나만 싣는다면 아무도 읽지 않을 것이다.
소스 파일도 신문 가사와 비슷하게 작성한다.
- 이름은 간단하면서도 설명이 가능하게 짓는다. 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다.
- 소스 파일 첫 부분은 고차원 개볌과 알고리즘을 설명한다.
- 아래로 내려갈수록 의도를 세세하게 묘사하고, 마지막에는 가장 저차원 함수와 세부 내역이 나온다.
개념은 빈 행으로 분리하라
거의 모든 코드는 왼쪽에서 오른쪽으로, 위에서 아래로 읽힌다. 각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다. 따라서 생각 사이는 빈 행을 넣어 분리해야 마땅하다.
패키지 선언부, import 문, 각 함수 사이에 빈 행이 들어간다. 너무도 간단한 규칙이지만 코드의 세로 레이아웃에 심오한 영향을 미친다. 빈 행은 새로운 개념을 시작한다는 시각적 단서다. 코드를 읽어 내려가다 보면 빈 행 바로 다음 줄에 눈길이 멈추게 된다.
세로 밀집도
줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다. 즉, 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다는 뜻이다.
수직 거리
함수 연관 관계와 동작 방식을 이해하려고 이 함수에서 저 함수로 오가며 소스 파일을 위아래로 뒤지는 등 뺑뺑이를 돌았으나 결국은 미로 같은 코드 때문에 혼란만 가중된 경험이 있는가? 함수나 변수가 정의된 코드를 찾으려 상곡 관계를 줄줄이 거슬러 올라간 경험이 있는가> 결코 달갑지 않는 경험이다. 시스템이 무엇을 하는 지 이해하고 싶은데, 이 조각 저 조각이 어디에 있는지 찾고 기억하느라 시간과 노력을 소모한다.
서로 밀접한 개념은 세로로 가까이 둬야 한다. 물론 두 개념이 서로 다른 파일에 속한다면 규칙이 통하지 앟ㄴ느다. 하지만 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 마땅하다. 이게 바로 protected 변수를 피해야 하는 이유 중 하나다 (protected 변수는 같은 패키지에서는 접근 제한이 없지만, 다른 패키지에서는 자식 클래스만 접근을 허용함).
같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다. 여기서 연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도다.
- 변수 선언: 변수는 사용하는 위치에 최대한 가까이 선언한다. 우리가 만든 함수는 매우 짧으므로 지역 변수는 각 함수 맨 처음에 선언이 될 것이다.
- 인스턴스 변수: 반면, 인스턴스 변수는 클래스 맨 처음에 선언한다. 변수 간에 세로로 거리를 두지 않는다. 잘 설계한 클래스는 대다수 클래스 메서드가 인스턴스 변수를 사용하기 때문이다.
- 종속 함수: 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다.
- 개념적 유사성: 어떤 코드는 서로 끌어당긴다. 개념적으로 친화도가 높기 때문이다. 예를 들어, 비슷한 동작을 수행하는 함수는 가까이 배치한다.
가로 형식 맞추기
한 행은 가로로 얼마나 길어야 적당할까? 앞서 행 길이와 마찬가지로 유명한 오픈 소스 프로젝트를 조사한 결과, 20자에서 60자 사이인 행이 총 행 수의 40%, 10자 미만은 30%, 80자 이후부터 행 수는 급격하게 감소한다. 프로그래머는 명백하게 짧은 행을 선호한다. 80자, 100자, 120자에 달해도 나쁘지는 않지만, 그 이상은 주의 부족이다. 되도록 120자 이내로 제한하는 것이 좋다.
가로 공백과 밀집도
가로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.
예: 할당 연산자
int lineSize = line.length();할당 연산자를 강조하기 위해 앞뒤에 공백을 줬다. 할당문은 왼쪽 요소와 오른쪽 요소가 분명히 나뉜다. 공백을 넣으면 두 가지 주요 요소가 확실히 나뉜다는 사실이 더욱 분명해진다.
예: 함수와 인수
public static double root(double a, double b, double c) {
double determinant = determinant(a, b, c);
}반면, 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않는다. 함수와 인수는 서로 밀접하기 때문이다. 공백을 넣으면 한 개념이 아니라 별개로 보인다. 함수를 호출하는 코드에서 괄호 안 인수는 공백으로 분리한다. 쉼표를 강조해 인수가 별개라는 사실을 보여주기 위해서다.
가로 정렬
가로 정렬은 별로 유용하지 못하다. 코드가 엉뚱한 부분을 강조해 진짜 의도가 가려지기 때문이다.
나쁜 예시(가로 정렬이 된 선언부):
public class TestClass {
private int field1 = 1;
protected int field2 = 2;
private String field3 = "3";
}위 선언문을 읽다 보면 변수 유형은 무시하고 변수 이름부터 읽게 된다. 따라서, 선언문과 할당문은 별도로 정렬하지 않는다. 정렬하지 않으면 오히려 중대한 결함을 찾기 쉽다.
정렬이 필요할 정도로 목록이 길다면 문제는 목록 길이지 정렬 부족이 아니다. 선언부가 길다면 클래스를 쪼개야 한다는 의미다.
들여쓰기
소스 파일은 윤곽도(outline)와 계층이 비슷하다. 파일 전체에 적용되는 정보가 있고, 파일 내 개별 클래스에 적용되는 정보가 있고, 클래스 내 각 메서드에 적용되는 정보가 있고, 블록 내 블록에 재귀적으로 적용되는 정보가 있다. 계층에서 각 수준은 이름을 선언하는 범위이자 선언문과 실행문을 해석하는 범위다.
이렇듯 범위(scope)로 이뤄진 계층을 표현하기 위해 우리는 코드를 들여쓴다. 들여쓴느 정보는 계층에서 코드가 자리잡은 수준에 비례한다. 프로그래머는 이런 들여쓰기 체계에 크게 의존한다. 왼쪽으로 코드를 맞춰 코드가 속하는 범위를 시각적으로 표현하면, 이 범위에서 저 범위로 빠르게 이동하기 쉬워진다.
가짜 범위
때로는 빈 while 문이나 for 문을 접한다. 이런 구존느 가능한 한 피하는 게 좋다. 피하지 못할 때는 빈 블록을 올바로 들여쓰고 괄호도 감싼다. 이렇게 하면 빈 블록이 빈 블록임을 명확히 알 수 있다.
while (dis.read(buf, 0, readBufferSize) != -1) {
// TODO
}팀 규칙
프로그래머라면 각자 선호하는 규칙이 있다. 하지만 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.
팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다. 그래야 소프트웨어가 일관적인 스타일을 보인다. 개개인이 따로따로 마음대로 짜대는 코드는 피해야 한다.
필자는 프로젝트를 처음 시작할 때 팀과 마주 앉아 어디에 괄호를 넣을지, 들여쓰기는 몇 자로 할지, 클래스, 변수, 메서드 이름은 어떻게 지을지 등 구현 스타일에 대해 논의했고 대략 10분 정도 걸렸다고 한다.
좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하자. 스타일은 일관적이고 매끄러워야 한다. 한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다. 온갖 스타일을 뒤섞어 소스 코드를 필요 이상으로 복잡하게 만드는 실수는 반드시 피해야 한다.