[CleanCode] 5장 형식 맞추기

5장 형식 맞추기

형식을 맞추는 목적

• 코드 형식은 중요하다.
• 코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다.

적절한 행 길이를 유지하라

• 일반적으로 행 길이가 큰 파일보다 작은 파일이 이해하기 쉽다.

신문 기사처럼 작성하라

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

개념은 빈 행으로 분리하라

• 거의 모든 코드는 왼쪽에서 오른쪽으로 그리고 위에서 아래로 읽힌다.
• 각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다.
• 생각 사이는 빈 행을 넣어 분리해야 마땅하다.

세로 밀집도

• 줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다.

수직 거리

• 서로 밀접한 개념은 세로로 가까이 둬야 한다.
• 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다.
  • 연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도다.
• 연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다.
• 변수선언: 변수는 사용하는 위치에 최대한 가까이 선언한다.
• 인스턴스 변수: 인스턴스 변수는 클래스 맨 처음에 선언한다.
• 종속 함수: 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.
• 개념적 유사성: 친화도가 높을수록 코드를 가까이 배치한다.

세로 순서

• 일반적으로 함수 호출 종속성은 아래 방향으로 유지한다.
• 호출되는 함수를 호출하는 함수보다 나중에 배치한다.

가로 형식 맞추기

• 행 길이는 120자 정도로 짧은 행이 바람직하다.

가로 공백과 밀집도

• 가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.
• ex) lineWidthHistogram.addLine(lineSize, lineCount);
  • 함수 이름과 괄호는 공백이 없다.
  • lineSize와 lineCount 사이에는 공백이 있다.

가로 정렬

• tab을 이용해 접근제한자, 자료형, 변수명 등을 정렬하는 것은 바람직하지 못하다.

들여쓰기

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

가짜 범위

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

• 빈 while 문이나 for 문의 경우 세미콜론을 새 행에사 제대로 들여써서 넣어준다.
• 그렇지 않으면 눈에 띄지 않는다.

팀 규칙

• 팀에 속한다면 팀의 규칙을 따라 일관적인 소프트웨어 스타일을 보여야 한다.
• 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다.
• 스타일은 일관적이고 매끄러워야 한다.
• 한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다.