[클린코드] 5장 형식 맞추기

5장 형식 맞추기

프로그래머는

• 깔끔한 형식에 맞춰 코드를 짜야한다.
• 코드 형식을 맞추기 위한 규칙을 정하고 이를 착실히 따라야 한다.
• 필요하다면 규칙을 자동으로 적용하는 도구를 활용한다.

이 장에서는 코드를 깔끔하고, 일관적이며, 질서 정연하게 형식을 맞추는 방법에 대해 알아본다.

---

형식을 맞추는 목적

코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.

코드 형식은 의사소통의 일환이며, 코드의 가독성은 앞으로 바뀔 코드 품질에 큰 영향을 미친다.

적절한 행 길이를 유지하라

대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다.

일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.

신문 기사처럼 작성하라

신문 기사의 흐름을 보면 첫 문단에 전체 기사 내용을 요약한다. 글을 읽어 내려갈수록 세세한 사실과 세부 사항이 나오게 된다.

소스 파일도 신문 기사와 비슷하게 작성하는 것이 좋다.

• 이름만으로 모듈을 설명할 수 있도록 짓는다.
• 소 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다.
• 아래로 내려갈수록 의도를 세세하게 묘사한다.
• 마지막에 가장 저차원 함수와 세부 내역이 나오도록 한다.

개념은 빈 행으로 분리하라

빈 행은 새로운 개념을 시작한다는 시각적 단서다.

세로 밀집도

세로 밀집도는 연관성을 의미한다.

서로 밀접한 코드 행은 세로로 가까이 놓여야 한다.

수직 거리

타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 마땅하다.

서로 밀접한 개념은 세로로 가까이 둬야 한다. 수직 거리로 연관성을 표현할 수 있다.

** 연관성: 한 개념을 이해하는 데 다른 개념이 중요한 정도

• 변수 선언

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

• 인스턴스 변수

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

← 클래스의 많은 메서드가 인스턴스 변수를 사용하기 때문에

• 종속 함수

한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.

가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.

• 개념적 유사성

직접적인 종속성을 가진 함수나, 비슷한 동작을 수행하는 일군의 함수와 같이 개념적 친화도가 높은 코드는 가까이 배치한다.

• 세로 순서

함수 호출 종속성은 아래 방향으로 유지한다. (호출하는 함수 → 호출되는 함수 순)

가장 중요한 개념을 가장 먼저 표현한다. 이때 세세한 사항을 최대한 배제한다. 세세한 사항은 가장 마지막에 표현한다.

팀 규칙

팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다.

그래야 소프트웨어가 일관적인 스타일을 유지할 수 있다.

---

마무리

요즘은 eslint, prettier 등의 도구가 굉장히 잘 되어있다.

나 또한 프로젝트를 시작하면 제일 처음 하는 게 팀원들과 eslint와 prettier 룰을 합의하는 것이다.

그리고 첫 커밋 이후에는 반드시 소스 코드 저장 시에나 적어도 커밋 시에 자동으로 포맷팅 하도록 설정하는 코드를 올린다.

코드 형식 및 스타일에 대한 협의와 자동화 설정이 이루어진 다음에야 비로소 코드를 작성할 수 있을 것이다.