Clean Code 5장 형식 맞추기

 

 

 

#1. 형식을 맞추는 목적

• 코드 형식은 너무나 중요하다!!!

 

#2. 적절한 행 길이를 유지하라

    1. 신문 기사처럼 작성하라

• 이름은 간단하면서도 설명이 가능하게 짓는다. 
• 소스파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 
• 아래로 내려갈수록 의도를 세세하게 묘사해라.

  2. 개념은 빈 행으로 분리하라

• 거의 모든 코드는 위에서 아래로, 왼쪽에서 오른쪽으로 읽힌다.
• 빈 행은 새로운 개념을 시작한다는 시각적 단서다.

  3. 세로 밀집도

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

  4. 수직 거리

• 서로 밀접한 개념은 세로로 가까이 두는 것으로 연관성을 표현한다.
• 연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도다.

  5. 변수, 함수 

• 변수는 사용하는 위치에 최대한 가까이 선언한다.
• 인스턴스 변수는 클래스 맨 처음에 선언한다.
• 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
• 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.

 

#3. 가로 형식 맞추기

• 필수는 아니지만 행으로 너무 긴 코드보다는 짧은 코드가 보기도 이해하기도 더 좋다.
• 들여쓰기한 파일은 구조가 한눈에 들어온다. 들여 쓰기를 제대로 쓰자.

 

#4. 팀 규칙

• 팀은 한 가지 규칙에 합의해야 하고, 모든 팀원은 그 규칙을 따라야 한다. 그래야 일관적일 수 있다.
• 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이루어진다.