형식 맞추기

프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다. 코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다. 팀으로 일한다면 팀이 합의해 규칙을 정하고 모두가 그 규칙을 따라야 한다. 필요하다면 규칙을 자동으로 적용하는 도구를 활용한다.

• 형식을 맞추는 목적
  • 코드 형식은 중요하다! 코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다.
• 적절한 행 길이를 유지하라
  • 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.
  • 신문기사처럼 작성하라
  • 개념은 빈 행으로 분리하라. 빈 행은 새로운 개념을 시작한다는 시각적 단서다.
  • 줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다. 즉, 서로 밀접한 코드 행은 세로로 가까이 놓아야 한다는 뜻이다.
  • 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다. 연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도다.
  • 변수는 사용하는 위치에 최대한 가까이 선언한다.
  • 인스턴스 변수는 클래스 맨 처음에 선언한다. 변수 간에 세로로 거리를 두지 않는다.
  • 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.
  • 어떤 코드는 서로 끌어당긴다. 개념적인 친화도가 높기 때문이다. 친화도가 높을수록 코드를 가까이 배치한다.
• 가로 형식 맞추기
  • 프로그래머는 명백하게 짧은 행을 선호한다. 그러므로 짧은 행이 바람직하다.
  • 가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.
  • 코드가 엉뚱한 부분을 강조해 진짜 의도가 가려지는 가로 정렬은 유용하지 못하다.
  • 범위로 이뤄진 계층을 표현하기 위해 코드를 들여쓴다. 들여쓰기 정도는 계층에서 코드가 자리잡은 수준에 비례한다.
• 팀 규칙
  • 팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다. 그래야 소프트웨어가 일관적인 스타일을 보인다.

좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하자. 스타일은 일관적이고 매끄러워야 한다. 한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다. 온갖 스타일을 뒤섞어 소스 코드를 필요 이상으로 복잡하게 만드는 실수는 반드시 피해야 한다.