[5장] 형식 맞추기

---

형식을 맞추는 목적

• 코드 형식은 의사소통의 일환으로, 너무 중요하기 때문에 맹목적으로 따르는 것은 ❌
• 목적은 코드의 가독성을 높이는 것!
  가독성↑ → 코드 품질↑

---

적절한 행 길이를 유지하라

👉🏻 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.
👉🏻 200줄 정도 추천

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

• 신문기사 : 표제 → 전체 기사 내용을 요약하는 첫 문단 → 세부사항
• 소스파일도 마찬가지!
  1) 이름은 간단하면서도 설명이 가능하게
  2) 소스파일 첫 부분은 고차원적 개념과 알고리즘 설명
  3) 아래로 갈 수록 의도를 세세하게 묘사
  4) 마지막엔 가장 저차원 함수와 세부 내역

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

• 일련의 행 묶음은 완결된 생각 하나를 표현한다.
• 생각 사이는 빈 행을 넣어 개념을 분리하는 것이 마땅하다.
• EX) <패키지 선언부> <import 문> <각 함수>

3. 세로 밀집도

• 세로 밀집도는 연관성을 의미한다.
• 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다.
• 의미 없는 주석으로 세로 밀집도 규칙을 어기지 말자.

4. 수직 거리

• 서로 밀접한 개념은 세로로 가까이, 한 파일에 둬야 한다.
  • 변수는 사용하는 위치에 최대한 가까이에 선언한다.
  • 인스턴스 변수는 클래스 맨 처음에 생성한다. (해당 언어의 잘 알려진 규칙으로)
  • 종속 함수는 세로로 가까이, 호출하는 함수가 가능하다면 먼저 배치한다.
  • 개념적 유사성, 개념적인 친화도가 높을 수록 코드를 가까이 배치한다.

5. 세로 순서

• 일반적으로 함수 호출 종속성은 아래 방향으로 유지한다.
• 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려가도록.

---

가로 형식 맞추기

👉🏻 20~60자, 45자 근처가 대부분이였는데, 저자는 120자 정도로 행 길이 제한 추천했다.

1. 가로 공백과 밀집도

• 가로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.
• 공백을 넣으면 주요 요소가 확실이 나뉜다.
  EX) 할당문, 괄호 안 인수, 연산자 우선순위 강조
• 밀접한 요소들은 공백을 넣지 않는다.
  EX) 함수 이름과 이어지는 괄호

2. 가로 정렬

• ❌
• 특정 구조를 강조하고자 할 때 사용한다.
• 단, 코드가 엉뚱한 부분을 강조해 진짜 의도가 가려질 수 있고, 코드 정렬 도구가 이를 무시할 수 있다.
• 오히려 정렬하지 않았을 때 중대한 결함을 찾기 쉽다는 장점이 있다.

3. 들여쓰기

• ⭐️
• 들여쓰기 정도는 계층에서 코득 자리잡은 수준에 비례한다.
• 클래스 정의처럼 파일 수준인 문장은 들여쓰지 않는다.

4. 가짜 범위

• 빈 while 문이나 for 문을 피할 수 없다면, 새 행에 제대로 들여써 세미콜론을 넣어라.

while(dis.read(buf,0,readBufferSize) != -1)
;

---

팀 규칙

• 팀에 속한다면 자신의 규칙이 아닌 팀의 규칙을 선호해야 한다.
• 보통 괄호의 위치, 들여쓰기 자, 클래스와 변수와 메서드 이름 규칙 등을 논의한다.
• 스타일은 일관적이고 매끄러워야 한다.

---

인상 깊었던...

프로그래머라면 각자 선호하는 규칙이 있다. 하지만 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.

좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이루어진다. 스타일은 일관적이고 매끄러워야 한다.

---