형식을 맞추는 목적

코드 형식은 중요하다. (융통성 없이 맹목적으로 따르면 안 된다)
코드 형식은 의사소통의 일환이다.
코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.
오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.

• 원할한 소통을 장려하는 코드 형식이란?

적절한 행 길이를 유지하라

• 보통 500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다.
• 반드시 지킬 엄격한 규칙은 아니지만 바람직한 규칙으로 삼으면 좋겠다.
• 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.

신문 기사처럼 작성하라

위에서 아래로 읽게
최상단에 요약하는 표제
첫 문단은 기사 내용을 요약
세세한 사실은 숨기고 커다란 그림을 보여준다.
내려가면 세세한 사실이 조금씩 드러난다. (날짜, 이름, 발언, 주장, 기타 세부사항이 나온다)

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

개념은 빈 행으로 분리하라

• 각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다.
• 생각 사이는 빈 행을 넣어 분리해야 마땅하다.

세로 밀집도

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

수직 거리

• 서로 밀접한 개념은 세로로 가까이 둬야 한다. (물론 두 개념이 서로 다른 파일에 속한다면 규칙이 통하지 않는다.)
• 하지만 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 마땅하다. (protected 변수를 피해야 하는 이유 중 하나)
• 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다.
  └ 여기서의 연관성 이란 한 개념을 이해하는 데 다른 개념이 중요한 정도

• 변수 선언 : 변수는 사용하는 위치에 최대한 가까이 선언한다.
  루프를 제어하는 변수는 흔히 루프 문 내부에 선언한다.
• 인스턴스 변수 : 인스턴스 변수는 클래스 맨 처음에 선언한다.
  변수간에 세로로 거리를 두지 않는다.
  잘 설계한 클래스는 클래스의 많은(혹은 대다수) 메서드가 인스턴스 변수를 사용하기 때문.
• 종속 함수 : 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
  또한, 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치하여 프로그램이 자연스럽게 읽히게 한다.
• 개념적 유사성 : 어떤 코드는 서로를 끌어당긴다. 개념적인 친화도가 높기 때문이다. 친화도가 높을수록 코드를 가까이 배치한다.
  친화도가 높은 요인은 여러가지다.
  한 함수가 다른 함수를 호출해 생기는 직접적인 종속성.
  변수와 그 변수를 사용하는 함수.
  비슷한 동작을 수행하는 일군의 함수

세로 순서

• 일반적으로 함수 호출 종속성은 아래 방향으로 유지한다. (다시 말해, 호출되는 함수를 호출하는 함수보다 나중에 배치)
  그러면 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.
• 신문 기사와 마찬가지로 가장 중요한 개념을 가장 먼저 표현 (세세한 사항을 최대한 배제)
• 세세한 사항은 가장 마지막에 표현한다.

가로 형식 맞추기

• 짧은 행이 바람직하다.

가로 공백과 밀집도

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

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

• 할당 연산자를 강조하기 위해 앞뒤에 공백을 준다.
• 할당문은 왼쪽 요소와 오른쪽 요소가 분명히 나뉜다.
• 공백을 넣으면 두 가지 주요 요소가 확실히 나뉜다는 사실이 더욱 분명해진다.
• 반면, 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않았다. (함수와 인수는 서로 밀접하기 때문)
• 공백을 넣으면 한 개념이 아니라 별개로 보인다.
• 함수를 호출하는 코드에서 괄호 안 인수는 공백을 분리했다. (쉼표를 강조해 인수가 별개라는 사실을 보여주기 위함)
• 연산자 우선순위를 강조하기 위해서도 공백을 사용 (수식을 읽기가 편하다.)
  승수 사이는 공백이 없다.(곱셈은 우선순위가 가장 높기 때문)
  항 사이에는 공백이 들어간다.(덧셈과 뺄셈은 우선순위가 곱셈보다 낮기 때문이다.)

가로 정렬

private Socket		socket;
private InputStream	input;
...

• 위와 같은 정렬이 별로 유용하지 못하다.
• 코드가 엉뚱한 부분을 강조해 진짜 의도가 가려진다.

private Socket socket;
private InputStream input;

• 정렬하지 않으면 오히려 중대한 결함을 찾기 쉽다.
• 정렬이 필요할 정도로 목록이 길다면 문제는 목록 길이지 정렬 부족이 아니다.

들여쓰기

• 소스 파일은 윤곽도(outline)와 계층이 비슷하다.
• 파일 전체, 파일 내 개별 클래스, 클래스 내 각 메서드, 블록 내 블록에 재귀적으로 적용되는 정보들이 있다.
• 계층에서 각 수준은 이름을 선언하는 범위이자 선언문과 실행문을 해석하는 범위다.
• 이렇듯, 범위(scope)로 이뤄진 계층을 표현하기 위해 우리는 코드를 들여쓴다.
• 들여쓰는 정도는 계층에서 코드가 자리잡은 수준에 비례한다.
• 클래스 정의처럼 파일 수준인 문장은 들여쓰지 않는다.
• 클래스 내 메서드는 클래스보다 한 수준 들여쓴다.
• 메서드 코드는 메서드 선언보다 한 수준 들여쓴다.
• 블록 코드는 블록을 포함하는 코드보다 한 수준 들여쓴다.
• 들여쓰기 한 파일은 구조가 한눈에 들어온다

가짜 범위

팀 규칙

• 팀은 한 가지 규칙에 합의해야 한다.
• 그리고 모든 팀원은 그 규칙을 따라야 한다.

밥 아저씨의 형식 규칙