5장 : 형식 맞추기

*<클린 코드>를 참고하여 작성한 글입니다.

형식 맞추기

형식을 깔끔하게 맞추어 코드를 짜야 한다. 코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다.

• 형식을 맞추는 목적 : 코드 형식은 의사소통의 일환이기 떄문
• 적절한 행 길이를 유지하라 : 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다
• 신문 기사처럼 작성하라 : 이름은 간단하면서도 설명이 가능하게, 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명. 내려갈수록 의도를 세세하게 묘사. 마지막에는 가장 저차원 함수와 세부 내역.
• 개념은 빈 행으로 분리하라 : 일련의 행 묶음은 완결된 생각 하나를 표현한다. 생각 사이는 빈 행을 넣어 분리해야 마땅하다.
• 세로 밀집도 : 서로 밀집한 코드 행은 세로로 가까이 놓여야 한다.
• 수직 거리 : 서로 밀접한 개념은 세로로 가까이 둬야 한다. 물론 서로 다른 파일에 속한다면 규칙이 통하지 않는다. 하지만 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 마땅하다. 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 종속적 관계가 없더라도 개념적인 친화도가 높다면 가까이 배치해야한다.
• 세로 순서 : 일반적으로 함수 호출 종속성은 아래 뱡향으로 유지. 호출되는 함수를 호출하는 함수보다 나중에 배치-> 고차원에서 저차원으로 자연스럽게 내려감.
• 가로 형식 맞추기 : 짧은 행이 바람직하다. 공백을 넣으면 두 가지 주요 요소가 확실히 나뉜다는 사실이 더욱 분명해진다. 들여쓰기를 해야 한다.
• 팀 형식 : 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이루어진다. 스타일은 일관적이고 매끄러워야 한다.