[Book - Clean Code] 5. 형식 맞추기

다 읽고 쓰자는 안일함에 다 읽어 놓고 쓰지는 않아서 이제야 쓴다.. (앞으로 읽자마자 쓰자. 반성하자.)

---

프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다.
이유는 코드 형식 또한 의사소통의 일환이기 때문이다.

오늘 구현한 기능이 다음 버전에서 바뀔 확률은 아주 높다.
그런데 그 코드의 가독성은 앞으로 바뀔 코드의 품질에 많은 영향을 미치듯,
원래 코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.

신문 기사처럼 작성하라

이름은 간단하면서도 설명이 가능하게 짓자.
즉, 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓자.

개념은 빈 행으로 분리하라

거의 모든 코드는 좌에서 우로 위에서 아래로 읽힌다.
각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다.
생각 사이는 빈 행을 넣어 분리해 보자.

빈 행은 새로운 개념을 시작한다는 시각적 단서이다.
만약에 빈 행을 빼버린다면 코드 가독성이 현저하게 떨어질 것이다.

세로 밀집도

줄바꿈이 개념을 분리한다면, 세로 밀집도는 연관성을 의미한다.
즉, 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다는 뜻이다.

세로 순서

일반적으로 함수 호출 종속성은 아래 방향으로 유지한다.

호출되는 함수를 호출하는 함수보다 나중에 배치하면, 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.

가로 정렬

public class Test {
    private String  s;
    private int     i;
    private char    c;
    private Request r;
    private long    testEntityId;
}

위 코드의 1번 선언부를 읽다 보면 변수 유형은 무시하고 변수 이름부터 읽게 된다.

정렬이 필요할 정도로 목록이 길다면 문제는 목록 길이지 정렬 부족이 아니다.
즉, 선언부가 길다면 클래스를 쪼개는 것을 고려해 보자.

---

좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하자.

스타일은 일관적이고 매끄러워야 한다.
즉, 한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다.