5장, 형식 맞추기

2022.03.24

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

형식을 맞추는 목적

코드 형식은 중요하다! 코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다.
오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다. 원래 코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.

적절한 행 길이를 유지하라

일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.

신문기사처럼 작성하라

독자는 위에서 아래로 기사를 읽는다.
첫 문단은 전체 기사 내용을, 세세한 사실은 숨기고 커다란 그림을 보여준다. 쭉 읽으며 내려가면 세세한 사실이 조금씩 드러난다.

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

개념은 빈 행으로 분리하라

거의 모든 코드는 왼쪽에서 오른쪽으로 그리고 위에서 아래로 읽힌다. 각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다. 생각 사이에는 빈 행을 넣어 분리해야 마땅하다.

패키지 선언부, import문, 각 함수 사이에 빈 행이 들어간다. 빈 행은 새로운 개념을 시작한다는 시각적 단서다.

세로 밀집도

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

수직거리

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

연관성이란 한 개념을 이해하는데 다른 개념이 중요한 정도다. 연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다.

  • 변수선언
    • 변수는 사용하는 위치에 최대한 가까이 선언한다.
  • 인스턴스 변수
    • 인스턴스 변수는 클래스 맨 처음에 선언한다.
    • 변수 간에 세로로 거리를 두지 않는다.
    • 잘 알려진 위치에 인스턴수 변수를 모은다는 사실이 중요하다.
  • 종속 함수
    • 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
    • 또한 가능한다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.
  • 개념적 유사성
    • 개념적인 친화도가 높은 코드는 가까이 배치한다.

세로 순서

일반적으로 함수 호출 종속성은 아래 방향으로 유지한다. 다시 말해, 호출되는 함수를 호출하는 함수보다 나중에 배치한다.

가로형식 맞추기


위 그래프를 보면 프로그래머는 명백하게 짧은 행을 선호한다는 것을 알 수 있다.
예전에는 오른쪽으로 스크롤할 필요가 절대로 없게 코드를 짰지만, 요즘은 모니터 해상도가 큰 환경이다.
저자는 개인적으로 120자 정도로 행 길이를 제한한다.

가로 공백과 밀집도

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

1private void measureLine(String line) {
2  lineCount++;
3  int lineSize = line.length();
4  totalChars += lineSize;
5  lineWidthHistogram.addLine(lineSize, lineCount);
6}

할당문은 왼쪽 요소와 오른쪽 요소가 분명히 나뉜다. 공백을 넣으면 두 가지 주요 요소가 확실히 나뉜다는 것이 분명해진다.
반면, 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않았다. 함수와 인수는 서로 밀접하기 때문이다.
함수를 호출하는 코드에서 괄호 안 인수는 공백으로 분리했다. 쉼표를 강조해 인수가 별개라는 사실을 보여주기 위해서다.

가로 정렬

1public class FitNesseExpedier implements ResponseSender
2{
3  private   Socket        socket;
4  private   InputStream   input;
5  private   OutputStream  output;
6  private   Request       request;
7}

위와 같은 정렬은 엉뚱한 부분을 강조해 진짜 의도가 가려진다.
예를 들어, 변수 유형은 무시하고 변수 이름부터 읽게 된다.
위와 같은 정렬은 좋지 않다.

들여쓰기

소스 파일은 윤곽도(outline)와 계층이 비슷하다.
파일 전체에 적용되는 정보, 파일 내 개별 클래스에 적용되는 정보, 클래스 내 각 메서드에 적용되는 정보 등.
이렇듯 범위(scope)로 이뤄진 계층을 표현하기 위해 코드를 들여쓴다.
들여쓰기가 없다면 인간이 코드를 읽기란 거의 불가능하다.

팀 규칙

팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다. 그래야 소프트웨어가 일관적인 스타일을 보인다.
좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하기 바란다.
한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다.