[Clean Code] Chapter5. 형식 맞추기

Clean Code

by. Robert C. Martin

05. 형식 맞추기

프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다.
코드 형식을 맞추기 위한 간단한 규칙을 정하고, 그 규칙을 따라야 한다.

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

형식을 맞추는 목적

주석은 나쁜 코드를 보완하지 못한다.

코드 형식은 중요하다!

• 코드 형식은 의사소통의 일환
  • 의사소통은 전문 개발자의 일차적인 의무
• 원래 코드는 사라질 수 있지만, 개발자의 스타일과 규율은 사라지지 않는다.

적절한 행 길이를 유지하라

신문 기사처럼 작성하라

• 이름은 간단하면서도 설명이 가능하게 짓는다.
  • 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경써서 짓는다.
• 파일의 첫 부분은 고차원 개념과 알고리즘을 설명한다.
  • 아래로 내려갈수록 의도를 세세하게 묘사한다.

개념은 빈 행으로 분리하라

• 모든 코드는 왼쪽에서 오른쪽으로, 그리고 위에서 아래로 읽힌다.
• 각 행은 수식이나 절, 일련의 행 묶음은 완결된 생각 하나를 표현한다.
• 생각 사이에는 빈 행을 넣어 분리한다.
• 새로운 개념을 시작하는 시각적인 단서.

세로 밀집도

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

수직 거리

• 서로 밀접한 개념은 세로로 가까이 둬야 한다.
  • protected를 피해야 하는 이유 중 하나.
  • 시스템이 무엇을 하는지 이해하고 싶은데 이 조각 저 조각 찾고 기억하는 것은 시간과 노력을 소모한다.
  • 두 개념이 서로 다른 파일에 속한다면 규칙은 통하지 않음.

변수 선언

• 변수는 사용하는 위치에 최대한 가까이 선언한다.
• 지역 변수는 각 함수 맨 처음에 선언한다.
• 루프를 제어하는 변수는 흔히 루프 문 내부에 선언한다.

인스턴스 변수

• 인스턴스 변수는 클래스 맨 처음에 선언한다.
• 변수간 세로로 거리를 두지 않는다.

종속 함수

• 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
• 호출하는 함수를 호출되는 함수보다 먼저 배치한다.
  • 프로그램이 자연스럽게 읽힌다.

개념적 유사성

• 개념적인 친화도가 높은 코드는 서로를 끌어당긴다.
  • 친화도가 높을 수록 가까이 배치한다.
• 친화도를 높이는 요인
  • 한 함수가 다른 함수를 호출해 생기는 종속성
  • 변수와 그 변수를 사용하는 함수
  • 비슷한 동작을 수행하는 일군의 함수

세로 순서

• 일반적으로 함수 호출 종속성은 아래 방향으로 유지된다.
  • 호출되는 함수를 호출하는 함수보다 나중에 배치한다.
  • 소스 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.

가로 형식 맞추기

• 짧은 행이 바람직하다.
  • 필자의 의견으로는 120자

가로 공백과 밀집도

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

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

• 할당 연산자를 강조하려고 앞 뒤에 공백을 준다.
  • 왼쪽 요소와 오른쪽 요소가 분명하게 나뉜다.
• 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않았다.
  • 함수와 인수는 서로 밀접하기 때문이다.
  • 함수를 호출하는 코드에서 괄호 안 인수는 공백으로 분리했다.
• 연산자 우선순위를 강조하기 위해서도 공백을 사용한다.

가로 정렬

• 특정 구조를 강조하고자 가로 정렬을 사용.
  • 하지만 엉뚱한 부분을 강조해 진짜 의도가 가려진다.

들여쓰기

• 소스 파일은 윤곽도와 계층이 비슷하다.
• 범위로 이뤄진 계층을 표현하기 위해 코드를 들여쓴다.
• 계층에서 코드가 자리잡은 수준에 비례한다.
  • 클래스 정의처럼 파일 수준인 문장은 들여쓰지 않는다.
  • 클래스 내 메서드는 클래스보다 한 수준 들여쓴다.
  • 메서드 코드는 메서드 선언보다 한 수준 들여쓴다.

팀 규칙

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