형식 맞추기

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

형식을 맞추는 목적

코드 형식은 중요하다.
코드 형식은 의사 소통의 일환이고 전문 개발자의 일차적인 의무다.
맨 처음에 잡아높은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.

원활한 소통을 장려하는 코드 형식은 무엇일까?

적절한 행 길이를 유지하라

200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다.
일반적으로 큰 파일보다 작은 파일이 이해가 더 쉽다.

• 신문 기사처럼 작성하라
  예) 신문기사 내용
  최상단에 기사를 몇 마디로 요약하는 표제
  전체 기사 내용 요약 (커다란 그림)
  세세한 사실 및 기타 세부사항
  이름은 간단하면서도 설명이 가능하게 짓는다.
  이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 수 있게 한다.
  소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다.
  마지막에는 가장 저차원 함수와 세부 내역이 나온다.

• 개념은 빈 행으로 분리하라
  빈 행은 새로운 개념을 시작한다는 시각적 단서다.

• 세로 밀집도
  세로 밀집도는 연관성을 의미한다.
  서로 밀접한 코드 행은 세로로 가까이 놓여야 한다.

• 수직 거리
  서로 밀접한 개념은 세로로 가까이 둬야 한다.
  여기서 연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도를 의미한다.

• 변수 선언
  변수는 사용하는 위치에 최대한 가까이 선언한다.

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

• 종속 함수
  한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
  호출하는 함수를 호출되는 함수보다 먼저 배치한다.

• 개념적 유사성
  어떤 코드는 서로 끌어당긴다.
  개념적인 친화도가 높을수록 코드를 가까이 배치한다.

• 세로 순서
  일반적으로 함수 호출 종속성은 아래 방향으로 유지한다.
  다시 말해, 호출되는 함수를 호출하는 함수보다 나중에 배치한다.
  그러면 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.
  가장 중요한 개념을 가장 먼저 표현한다.
  소스 파일에서 첫 함수 몇 개만 읽어도 개념을 파악하기 쉬워진다.

가로 형식 맞추기

짧은 행이 바람직하다.
120자 정도로 행 길이를 제한한다.

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

• 가로 정렬
  가로 정렬은 유용하지 못하다.
  엉뚱한 부분을 강조해 진짜 의도가 가려지기 때문이다.

• 들여쓰기
  범위로 이루어진 계층을 표현하기 위해 코드를 들여쓴다.
  들여쓰기 무시하기를 하지 않도록 항상 신경 쓰자

팀 규칙

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