[BOOK - 클린코드] Chapter 5. 형식 맞추기

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

 

형식을 맞추는 목적

---

• 코드형식은 너무나 중요하다. 저자는 '돌아가는 코드' 보다 코드 형식이 중요하다고 한다.
• 코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다.
  • 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.

 

적절한 행 길이를 유지하라

---

• 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.
• 유명한 7개의 프로젝트(Junit, Fitnesse, testNG, tam, Jdepend, Ant, Tomcat) 마다 평균 라인 수의 차이가 있긴 하지만, 500줄을 넘어가는 파일이 없거나 파일마다 200줄 라인으로도 커다란 시스템을 구축할 수 있다는 사실을 알 수 있다.

 

신문 기사처럼 작성하라

• 좋은 신문의 기준
  • 최상단에 기사를 몇 마디로 요약하는 표제가 나온다. 독자는 표제를 보고서 기사를 읽을지 말지 결정한다.
  • 첫 문단은 전체 기사 내용을 요약한다. 세세한 사실은 숨기고 커다란 그림을 보여준다.
  • 쭉 읽어 내려가면 세세한 사실이 조금씩 드러난다.
• 소스 파일도 이와 비슷하게 작성한다.
  • 이름은 간단하면서도 설명이 가능하게 짓는다. 이름만 보고도 올바른 모듈을 보는 것인지 파악 가능하도록 신경 쓴다.
  • 소스 파일의 첫 부분은 고차원(단순하게) 개념과 알고리즘을 설명한다.
  • 아래로 내려갈수록 의도를 세세하게 묘사한다.

 

개념은 빈 행으로 분리하라

각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다.
생각 사이는 빈 행을 넣어 분리해야 한다. 빈 행은 새로운 개념을 시작한다는 시각적 단서다.

예를 들어 다음과 같은 코드가 적절하다.

package fitnesse.wikitext.widgets;

import java.util.regex.*;

public class BoldWidget extends ParentWidget {
  public static final String REGEXP = "'''.+?'''";
  private static final Pattern pattern = Pattern.compile("'''(.+?)'''", Pattern.MULTILINE + Pattern.DOTALL);

  public BoldWidget(ParentWidget parent, String text) throws Exception {
  	super(parent);
  	Matcher match = pattern.matcher(text);
  	match.find();
  	addChildWidgets(match.group(1));
  }

  public String render() throws Exception {
    StringBuffer html = new StringBuffer("<b>");
    html.append(childHtml()).append("</b>");
    return html.toString(); 
  }
}

 

세로 밀집도

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

 

수직 거리

함수 연관 관계와 동작 방식을 이해하려고 이 함수에서 저 함수로 오가며 소스 파일을 위아래로 뒤지는 등 뺑뻉이를 돌아도 혼란만 가중된 코드가 있다.
시스템이 어떻게 동작하는지 이해하려고 해도, 이 조각 저 조각이 어디에 있는지 찾고 기억하느라 시간과 노력을 소모하게 된다.

 

개념적 유사성

• 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다.
  • 여기서 연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도다.
• 신문 기사와 마찬가지로 가장 중요한 개념을 가장 먼저 표현한다.
  • 가장 중요한 개념을 표현할 땐 세세한 사항을 최대한 배제한다.
  • 세세한 사항은 가장 마지막에 표현한다.
  • 그러면 독자가 소스 파일에서 첫 함수 몇 개만 읽어도 개념을 파악하기 쉬워진다.

 

변수 선언

변수는 사용하는 위치에 최대한 가까이 선언한다.
만드는 함수가 매우 짧으면 지역 변수는 각 함수 맨 처음에 선언한다.

 

인스턴스 변수

인스턴스 변수는 클래스 맨 처음에 선언한다.
변수 간에 세로로 거리를 두지 않는다. 잘 설계한 클래스는 클래스 메서드가 인스턴스 변수를 사용하기 때문이다.

 

종속 함수

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

• 참고: 함수를 호출할 때 리터럴을 인수로 전달하는 방식과 함수 안에서 정의하고 사용하는 방식이 존재한다.
  • 보통 함수 안에서 리터럴을 사용하게 되면 저수준에서(상세한) 사용하게 되는 것이다.
  • 적절한 수준을 고려하여 인수로 넘길지 함수 안에서 사용할 지 정해야 한다.

 

가로 형식 맞추기

---

저자는 120자 정도가 적당하고 한다.

 

가로 공백과 밀집도

가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.
공백을 넣으면 두 가지 주요 요소가 확실히 나뉜다는 사실이 더욱 분명해진다.

 

예를 들어 다음과 같다.

• 할당 연산자의 공백 -> 할당문은 왼족 요소와 오른쪽 요소가 분명히 나뉜다.
• 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않는다. -> 함수와 인수는 서로 밀접하기 때문에 공백을 두지 않는다.
  • 인수 안에서는 별개의 인수이고, 쉼표를 강조하기 위해 공백을 넣는다.

private void measureLine(String line) {
  lineCount++;
  int lineSize = line.length();
  totalChars += lineSize;
  lineWidthHistogram.addLine(lineSize, lineCount);
  recordWidestLine(lineSize);
}

 

가로 정렬

가로 정렬은 유용하지 못하다. 코드가 엉뚱한 부분을 강조해 진짜 의도가 가려진다.
예를 들어 다음과 같은 코드는 좋지 못하다.

• 변수 유형은 무시하고 변수 이름부터 읽게 된다.
• 할당 연산자는 보이지 않고 오른쪽 피연산자에 눈이 간다.
• 정렬이 필요할 정도로 목록이(필드가 많다면) 길다면 목록 길이가 문제일 가능성이 높다. 이는 클래스를 쪼개야 한다는 의미다.

public class FitNessExpediter implements ResponseSender {
  private Socket  socket;
  private InputStream input;
  private OutputStream  output;
  private Request request;
  ...
}

 

가짜 범위

다음과 같은 범위가 없는 빈 while 문이나 for 문은 새로운 행에다 세미콜론(;)을 써준다.

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

 

팀 규칙

• 각자 선호하는 스타일이 있겠지만 최우선으로 해야할 것은 팀 규칙을 따르는 것이다.
• 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다. 스타일은 일관적이고 매끄러워야 한다.