Clean Code - 05. 형식 맞추기

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

형식을 맞추는 목적

코드 형식은 의사소통의 일환이다.

오늘 구현한 기능이 다음 버전에서 바뀔 확률은 아주 높지만,
오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.

맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.
원래 코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.

적절한 행 길이를 유지하라

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

신문 기사처럼 작성하라

이름은 간단하면서로 설명이 가능하게 짓는다.
소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다.
아래로 내려갈수록 의도를 세세하게 묘사한다.
마지막에는 가장 저차원 함수와 세부 내역이 나온다.

개념은 빈 행으로 분리하라

각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다.
생각 사이는 빈 행을 넣어 분리해야 마땅하다.
빈 행은 새로운 개념을 시작한다는 시각적 단서다.

세로 밀집도

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

수직 거리

서로 밀접한 개념은 세로로 가까이 둬야 한다.
서로 밀접한 개념은 한 파일에 속해야 마땅하다.
밀접한 두 개념은 세로 거리로 연관성을 표현한다.

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

• 변수 선언
  • 변수는 사용하는 위치에 최대한 가까이 선언한다.
• 인스턴스 변수
  • 클래스 맨 처음에 선언한다.
• 종속 함수
  • 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
  • 상수를 알아야 마땅한 함수에서 실제로 사용하는 함수로 상수를 넘겨주는 방법이 더 좋다.
• 개념적 유사성
  • 친화도가 높을수록 코드를 가까이 배치한다.

세로 순서

호출하는 함수 -> 호출되는 함수 순서로 배치
소스 코드 모율이 고차원 -> 저차원으로 자연스럽게 내려간다.

가로 형식 맞추기

한 행은 가로로 얼마나 길어야 적당할까?
100~120자 정도 나쁘지 않고, 그 이상은 주의부족이다.

가로 공백과 밀집도

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

• 할당 연산자 : 할당문은 왼쪽 요소와 오른쪽 요소가 분명히 나뉜다.
• 함수 이름과 이어지는 괄호 사이에는 공백 X : 함수와 인수는 서로 밀접
• 함수를 호출하는 괄호 안 인수는 공백으로 분리
• 연산자 우선순위 강조를 위해 공백 사용

가로 정렬

들여쓰기

범위로 이뤄진 계층을 표현하기 위해 코드를 들여쓴다.
들여쓰는 정도는 계층에서 코드가 자리잡은 수준에 비례한다.
왼쪽으로 코드를 맞춰 코드가 속하는 범위를 시각적으로 표현한다.

• 들여쓰기 무시하기 ```java // bad public String CommentWidget(ParentWidget parent, String text){super(parent, text);} public String render() throws Exception {return “”; }

// good public String CommentWidget(ParentWidget parent, String text) {super(parent, text); }

public String render() throws Exception { return “”; }

### 가짜 범위
```java
// bad
while (dis.read(buf, 0, readBufferSize != -1))
;

// good
while (dis.read(buf, 0, readBufferSize != -1)) {
    ;
}

팀 규칙

팀에 속한다면 프로그래머 각자의 선호보다 팀 규칙을 선호해야 한다.
스타일은 일관적이고 매끄러워야 하며,
한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 주어야 한다.

내 생각

프로젝트할 때, 프론트 코드를 airbnb 코딩 컨벤션에 맞춰 개발한 적이 있다.
꽤나 엄격해서 별 것 아닌 부분들에서 힘들었는데 (for문 변수라던지 뭐..),
나중에 코드를 보면 확실히 읽기 좋기는 했다.
앞으로 좀 더 점검하고 확인하며 코드 짜야지…

• 들여쓰기 할 때 tab 파, 스페이스 파가 있는데 당신은 무슨 파이신가요? 나는 tab 파다.