[클린코드 스터디] 5장. 형식 맞추기

5장. 형식 맞추기

🧾 형식은 의사소통이다

클린 코드를 짜기 위해선 코드의 내용뿐만 아니라 형식도 중요하다.
형식을 잘 맞추면 코드가 더 빠르게 읽히고, 이해도도 높아진다.

실제로 저자는 이렇게 말한다:

“형식을 맞추지 않으면, 마치 술 취한 뱃사람이 짠 것처럼 보인다.”

읽기 좋은 코드는 깔끔하고, 질서 있고, 전문적으로 보인다.
이제부터는 신뢰감을 주는 코드를 짜기 위해, 형식에 대해서도 함께 공부해보자.

---

📰 신문처럼 작성하라

좋은 신문 기사는 항상 제목 → 요약 → 세부사항 순으로 흐른다.
코드도 마찬가지다.

• 파일 상단에는 고수준 함수
• 아래로 내려갈수록 구체적인 구현
• 읽는 사람은 위에서부터 차근차근 내려오며 맥락을 파악하게 된다

이런 흐름이 잡힌 코드는 읽는 사람에게 "이건 잘 짜여 있겠구나"라는 인상을 준다.

📏 세로 형식의 기본

• 빈 줄로 개념을 나누고
• 관련 있는 코드들은 가까이 배치하고
• 호출하는 함수는 위에, 호출되는 함수는 아래에
• 중요한 개념부터 위에 배치하고
• 파일 크기는 200줄~500줄 정도가 이상적

💬 예시 1: 빈 줄이 있는 코드 (가독성 ↑)

public class BoldWidget extends ParentWidget {
  public static final String REGEXP = "'''.+?'''";

  private static final Pattern pattern = Pattern.compile("'''(.+?)'''");

  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 {
    return "<b>" + childHtml() + "</b>";
  }
}

💬 예시 2: 빈 줄 없이 몰려 있는 코드 (가독성 ↓)

public class BoldWidget extends ParentWidget {
  public static final String REGEXP = "'''.+?'''";
  private static final Pattern pattern = Pattern.compile("'''(.+?)'''");
  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 {
    return "<b>" + childHtml() + "</b>";}
}

→ 같은 코드라도 줄 하나로 가독성이 완전히 달라진다.

📐 가로 형식도 중요하다

• 행 길이는 100~120자 정도가 이상적
• 할당문, 연산자 앞뒤로 공백을 활용해서 흐름을 나눠준다
• 함수와 괄호는 붙이고, 인수는 쉼표로 공백 분리

int lineSize = line.length();
totalChars += lineSize;

public static double root(double a, double b, double c) {
  return (-b + Math.sqrt(b*b - 4*a*c)) / (2*a);
}

🔍 들여쓰기와 정렬

• 들여쓰기는 범위와 구조를 보여주는 시각적 장치다
• 클래스 → 메서드 → 블록 순으로 한 수준씩 들여쓴다
• 가로 정렬(예: 변수 선언 정렬)은 가독성을 해치는 경우도 많다

// 비추천: 정렬로 인해 중요한 정보가 흐려짐
private   InputStream     input;
private   OutputStream    output;

// 추천: 들여쓰기만으로도 충분
private InputStream input;
private OutputStream output;

🤝 팀 규칙이 가장 중요하다

개인 취향보다 더 중요한 건 팀 전체의 합의다.
서로 다른 스타일이 섞이면, 코드베이스는 금세 복잡하고 어지럽게 느껴진다.

그래서 팀은 스타일 가이드를 정하고, 도구로 강제하며, 모두가 함께 지켜야 한다.

---

✍️ 마무리하며

형식은 단순히 보기 좋기 위한 게 아니다.
코드를 더 빠르게 읽고, 쉽게 이해할 수 있도록 돕는 도구다.

• 신문처럼 위에서 아래로 흐름 있게 작성하고
• 개념은 빈 줄로 나눠주고
• 관련 있는 코드는 가까이 두고
• 중요한 건 위쪽에 먼저 보여주고
• 그리고 무엇보다, 같은 규칙을 꾸준히 지키는 것

한 줄 한 줄에 들어간 작은 배려들이 결국 클린 코드의 시작점이 된다는 것을 명심하자!