5장 형식 맞추기

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

- 간단한 규칙을 정하고 따라야 한다.

- 팀이 합의해 규칙을 정하고 모두가 따라야 한다.

- 규칙을 자동으로 적용하는 도구를 활용한다.

형식을 맞추는 목적

- 의사소통이다.

- 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드이 품질에 지대한 영향을 미친다.

적절한 행 길이를 유지해라

신문 기사처럼 작성하라

개념은 빈 행으로 분리하라

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

세로 밀집도

- 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다.

수직거리

- 서로 밀접한 개념은 세로로 가까이 둬야 한다.

- 연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다.

변수선언

- 사용하는 위치에 최대한 가까이

인스턴스 변수

- 클래스 맨 처음에 선언

종속함수

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

- 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.

가로정렬

- 코드가 엉뚱한 부분을 강조해 진짜 의도가 가려질 수 있다. (변수 = 값, 탭 간격을 맞추려는 경우)

들여쓰기

- 소스파일은 윤곽도와 계층이 비슷하다.

- 범위로 이뤄진 계층을 표현하기 위해 코드를 들여쓴다.

가짜 범위

- 빈 while문이나 for문은 세미콜론(;)을 넣어준다.

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

;

팀 규칙

- 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.

- 팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다. 그래야 소프트웨어가 일관적인 스타일을 보인다.

좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하기 바란다.

스타일은 일관적이고 매끄러워야 한다. 한 소스 파일에서 봤던 형식이 다른 소스파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다.