클린코드 #5 형식 맞추기


뚜껑을 열었을 때 독자들이 코드가 깔끔하고, 일관적이며, 꼼꼼하다고 감탄하면 좋겠다. 질서 정연하다고 탄복하면 좋겠다. 모듈을 읽으며 두 눈이 휘둥그래 놀라면 좋겠다. 전문가가 짰다는 인상을 심어주면 좋겠다. 프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다. 코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다.

형식을 맞추는 목적

코드 형식은 중요하다.

너무나도 중요하므로 융퉁성 없이 맹목적으로 따르면 안된다. 코드 형식은 의사소통의 일환이다. 오늘 구현한 기능이 다음 버전에서 바뀔 확률은 아주 높다. 그런데 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다. 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다. 원래 코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다. 원활한 소통을 장려하는 코드 형식은 무엇일까?

적당한 행 길이를 유지하라

자바에서 파일 크기는 클래스 크기와 밀접하다. 500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다는 사실을 기억하자. 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.

신문 기사처럼 작성하라

소스파일을 신문 기사와 비슷하게 작성하라. 이름은 간단하면서도 설명이 가능하게 짓는다. 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다. 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다. 마지막에는 가장 저차원 함수와 세부 내역이 나온다.

개념은 빈 행으로 분리하라

빈 행은 새로운 개념을 시작한다는 시각적 단서다. 코드를 읽어내려가다 보면 빈 행 바로 다음 줄에 눈길이 멈춘다. 코드 가독성을 빈 행으로 높일 수 있다.

세로 밀집도

줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다. 서로 밀접한 코드 행은 세로로 가까이 놓아야 한다는 뜻이다. 의미 없는 주석으로 인스턴스 변수를 떨어트려 놓는건 좋지 않다.

클래스가 있는 객체 지향 프로그래밍에서 인스턴스 변수는 클래스에 정의된 변수로, 이를 위해 각각의 인스턴스화된 클래스의 객체가 별도의 사본이나 인스턴스를 가지고 있다. 인스턴스 변수는 클래스 변수와 비슷하다.

수직 거리

함수나 변수가 정의된 코드를 찾으려 상속 관계를 줄줄이 거슬러 올라가는 것은 소모적인 일이다. 서로 밀접한 개념은 세로로 가까이 둬야한다. 물론같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다. 여기서 연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 일이다.

  • 변수 선언

    • 변수는 사용하는 위치에 최대한 가까이 선언한다
    • 우리가 만든 함수는 매우 짧으므로 지역 변수는 각 함수 맨 처음에 선언한다
    • 루프를 제어하는 변수는 흔히 루프 문 내부에 선언한다
  • 인스턴스 변수

    • 반면 인스턴스 변수는 클래스 맨 처음에 선언한다
    • 변수 간에 세로로 거리를 두지 않는다
    • C++에서는 인스턴스 변수를 클래스 마지막에 선언한다
    • Java에서는 클래스 맨 처음에 선언한다
    • 둘 중 어찌됐든 잘 알려진 위치에 인스턴스 변수를 모은다는 사실이 중요하다
  • 종속 함수

    • 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다
    • 프로그램이 자연스럽게 읽히도록 호출하는 함수를 호출되는 함수보다 먼저 배치한다
    • 상수를 알아야 마땅한 함수에서 실제로 사용하는 함수로 상수를 넘겨주는 방법이 더 좋다
  • 개념적 유사성

    • 친화도가 높은 코드는 서로를 끌어당긴다
    • 친화도가 높은 코드 예: 한 함수가 다른 함수를 호출해 생기는 직접적인 종속성, 비슷한 동작을 수행하는 일군의 함수 (명명법이 같고 기본 기능이 유사하고 간단한 함수)

세로 순서

일반적으로 함수 호출 종속성은 아래 방향으로 유지한다. 다시 말해, 호출되는 함수를 호출하는 함수보다 나중에 배치한다. 그러면 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.

가로 형식 맞추기

한 행은 가로로 얼마나 길어야 적당할까? 분석한 결과를 살펴보면 80자 이후부터 행 수는 급격하게 감소한다. 프로그래머는 명백하게 짧은 행을 선호한다. 100자나 120자에 달해도 나쁘지 않지만 그 이상은 주의부족이다.

가로 공백과 밀집도

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

private void measureLine(String line) {
lineCount++;
int lineSize = line.length();
totalChars += lineSize;
lineWidthhistogram.addLine(lineSize, lineCount);
recordWidestLine(lineSize);
}
  • 할당 연산자를 강조하려고 앞뒤에 공백을 줬다.
    • 공백을 넣으면 두 가지 주요 요소가 확실히 나뉜다는 사실이 분명해진다.
  • 반면, 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않았다.
    • 함수와 인수는 서로 밀접하기 때문이다.
    • 공백을 넣으면 한 개념이 아니라 별개로 보인다.
  • 함수를 호출하는 코드에서 괄호 한 인수는 공백으로 분리했다.
    • 쉼표를 강조해 인수가 별개라는 사실을 보여주기 위해서이다.

가로 정렬

선언문과 할당문을 별도로 정렬하지 않는다. 정렬하지 않으면 오히려 중대한 결함을 찾기 쉽다. 정렬이 필요할 정도로 목록이 길다면 문제는 목록 길이지 정렬 부족이 아니다. 선언부가 길다면 클래스를 쪼개는것이 좋다.

들여쓰기

소스 파일은 윤곽도와 계층이 비슷하다. 계층에서 각 수준은 이름을 선언하는 범위이자 선언문과 실행문을 해석하는 범위다. 범위scope로 이루어진 계층을 표현하기 위해 우리는 코드를 들여쓴다. 들여쓰는 정도는 계층에서 코드가 자리잡은 수준에 비례한다.

  • 클래스 정의처럼 파일 수준인 문장은 들여쓰지 않는다
  • 클래스 내 메서드는 클래스보다 한 수준 들여쓴다
  • 메서드 코드는 메서드 선언보다 한 수준 들여쓴다
  • 블록 코드는 블록을 포함하는 코드보다 한 수준 들여쓴다

들여쓰기 한 파일은 구조가 한눈에 들어온다. 변수, 생성자 함수, 접근자 함수, 메서드가 금방 보인다. 반면, 들여쓰기 하지 않은 코드는 열심히 분석하지 않는 한 거의 불가해하다.

가짜범위

때로는 빈 while문이나 for 문을 접한다. 피하지 못할 때는 빈 블록을 올바로 들여쓰고 괄호로 감싼다. 세미콜론;은 새 행에다 제대로 들여써서 넣어준다. 그렇게 하지 않으면 눈에 띄지 않는다.

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

팀 규칙

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

Previous post:

Next post: