5장 형식 맞추기

프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다.

  • 코드 형식을 맞추기 위해 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다.

  • 팀으로 일한다면 팀이 합의해 팀 규칙을 정하고 팀원 모두가 그 규칙을 따라야 한다.

  • 필요하다면 규칙을 자동으로 적용하는 도구를 활용한다.

형식을 맞추는 목적

코드 형식은 너무나도 중요하므로 융통성 없이 맹목적으로 따르면 안된다. 코드 형식은 의사소통의 일환이다. (의사소통은 개발자의 일차적인 의무다.)

오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다. 오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미치기 때문이다.

적절한 행 길이를 유지하라

유명 프로젝트를 조사한 결과 평균 파일 크기가 100줄 ~ 200줄이었다.

⇒ 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다. (바람직한 규칙으로 삼자)

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

신문 기사처럼 작성하라

가장 중요한 개념을 가장 먼저 표현한다. 가장 중요한 개념을 표현할 때는 세세한 사항을 최대한 배제한다.

호출되는 함수를 호출하는 함수보다 나중에 배치한다.

  • 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명하자.

  • 아래로 내려갈수록 의도를 세세하게 묘사하자.

  • 마지막에는 가장 저차원 함수와 세부 내역이 나오게 작성하자.

개념은 빈 행으로 분리하라

빈 행은 새로운 개념을 시작한다는 시각적 단서다.

패키지 선언부, import 문, 각 함수 사이에 빈 행을 넣자. 빈 행을 빼버린 코드는 코드 가독성이 현저하게 떨어져 암호처럼 보인다.

세로 밀집도 & 수직 거리

세로 밀집도는 연관성을 의미한다. 즉, 서로 밀접한 개념(코드 행)은 세로로 가까이 놓여야 한다는 뜻이다.

서로 밀접한 개념은 한 파일에 속해야 마땅하다. (이게 바로 protected 변수를 피해야하는 이유 중 하나다.)

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

변수 선언

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

    우리가 만드는 함수는 매우 짦으므로 지역 변수는 각 함수 맨 처음에 선언한다.

private static void readPreferences() {
    InputStream is = null; // 각 변수는 맨 처음에 선언한다.
    try {
        is = new FileInputStream(getPreferencesFile());
        setPreferences(new Properties(getPreferences()));
        getPreferences().load(is);
    } catch
    // ... 생략 
}

  • 루프를 제어하는 변수는 흔히 루프 문 내부에 선언한다.

public int countTestCases() {
    int count = 0;
    for (Tech each: tests) // 루프를 제어하는 변수는 흔히 루프 문 내부에 선언한다. 
        count += each.countTestCases();
    return count;
}

인스턴스 변수

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

변수 간에 세로로 거리를 두지 않는다. 잘 설계한 클래스는 많은 (혹은 대다수) 클래스 메서드가 인스턴스 변수를 사용하기 때문이다.

종속 함수

한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.

또한 가능하다면 호출하는 함수(Caller)를 호출되는 함수(Callee)보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다.

  • (교재 p104) 목록 5-5. 상수를 적절한 수준에 두는 좋은 예제

getPageNameOrDefault 함수 안에서 "FrontPage" 상수를 사용하는 방법도 있다. 하지만 기대와는 달리 잘 알려진 상수가 적절하지 않은 저차원 함수에 묻힌다. 상수를 알아야 마땅한 함수(Caller)에서 실제로 사용하는 함수(Callee)로 상수를 넘겨주는 방법이 더 좋다.

개념적 유사성

친화도가 높을수록 코드를 가까이 배치한다.

  • 친화도를 높이는 요인

    • 한 함수가 다른 함수를 호출해 생기는 직접적인 종속성

    • 비슷한 동작을 수행하는 일군의 함수

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

가로 형식 맞추기

프로그래머는 명백하게 짧은 행을 선호한다. 한 행에 100 ~ 120자를 넘지 않는 것이 바람직하다.

가로 공백과 밀집도

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

  • 앞뒤에 공백을 줘서 할당 연산자를 강조

    totalChars += lineSize;

    ⇒ 공백을 넣으면 두 가지 주요 요소가 확실히 나뉜다.

  • 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않는다.

    lineWidthHistogram.addLine(lineSize, lineCount);

    ⇒ 공백을 넣으면 한 개념이 아니라 별개로 보인다.

  • 함수를 호출하는 코드에서 괄호 안 인수는 공백으로 분리했다.

    addLine(lineSize, lineCount);

    ⇒ 쉼표를 강조해 인수가 별개라는 사실을 보여준다.

가로 정렬

가로 정렬은 하지 말자. 코드의 엉뚱한 부분을 강조해 진짜 의도가 가려지기 때문이다.

public class Example {
  private Socket	      socket;
  private InputStream	      input;
  private FitNesseContext     context;
}

  • 예를 들어, 위 선언부를 읽다 보면 변수 타입은 무시하고 변수 이름부터 읽게 된다.

  • 마찬가지로, 위 할당문을 훑어보면 할당 연산자는 보이지 않고 오른쪽 피연산자에 눈이 가게 된다.

들여쓰기

소스 파일은 윤곽도 계층과 비슷하다. 프로그래머는 들여쓰기 체계에 크게 의존한다.

왼쪽으로 코드를 맞춰 코드가 속하는 범위를 시각적으로 표현한다. 그러면 이 범위에서 저 범위로 재빨리 이동하기 쉬워진다. 현재 상황과 무관한 if 문/while 문 코드를 일일이 살펴볼 필요가 없다.

간단한 if문, 짧은 함수에서 들여쓰기를 규칙을 무시하고픈 유횩이 생기지만, 한 행에 범위를 뭉뚱그린 코드를 피하고 들여쓰기를 꼭 하자!

가짜 범위

빈 while 문이나 for문을 피한다. 피하지 못한다면 세미콜론(;)을 새 행에다 제대로 들여써서 넣어준다.

before

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

⇒ 이런 식의 코드는 while 문 아래의 코드가 while문과 연관된 코드라고 오해의 소지를 만든다.

after

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

⇒ 새 행에다 세미콜론을 제대로 들여써야 빈 for문이나 while문인지 눈에 띈다.

팀 규칙

팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다. 그래야 소프트웨어가 일관적인 스타일을 보인다. 개개인이 따로국밥처럼 맘대로 짜대는 코드는 피해야 한다.

Previous4장 주석Next6장 객체와 자료구조

Last updated