[Clean code] 5장 형식맞추기

프로그래머라면 형식에 맞춰 코드를 작성해야 한다. 코드 형식을 맞추기 위해 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다. 팀으로 일한다면 팀이 합의하여 모두가 규칙을 정하고 그 규칙을 따라야 한다. 필요하다면 규칙을 정하는 도구를 사용하자.

---

1. 형식을 맞추는 목적

코드 형식은 매우 ! 중요하다. 코드형식은 의사소통의 일환이다. 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드 품질에 대해 지대한 영향을 미친다.

2. 적절한 행의 길이를 유지하라.

자바에서 파일크기는 클래스의 크기와 밀접하다. 많은 오픈소스들을 보면 작은 크기의 파일(클래스)들로 이루어져 가독성이 좋은걸 볼 수 있다. 일반 적으로 작은 파일이 큰 파일 보다 이해하기가 쉽다.

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

잘 작성되어진 신문기사를 보면 최상단에 기사를 몇 마디로 요약하는 표제가 나온다. 이 후 첫문단은 전체 기사 내용을 요약한다. 세세한 사실을 숨기고 커다란 그림을 보여준다. 쭉 읽으며 내려가면 세세한 사실이 조금씩 드러난다.
이처럼 소스파일도 신문 기사와 비슷하게 작성해야한다. 이름을 간단하면서도 설명 가능하게 짓는다. 이름만 보고도 올바른 모듈을 살펴보고 있는지 판단 할 수 있어야 한다.
소스파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈 수록 의도를 세세하게 묘사한다. 마지막에는 가장 저차원 적인 함수와 세부내역이 나온다.

4. 개념을 빈 행으로 분리하라.

거의 모든 코드는 왼쪽에서 오른쪽으로 그리고 위에서 아래로 읽힌다 . 각행은 수식이나 절을 나타내고 일련의 행 묶음은 완결된 생각 하나를 표현한다. 생각 사이는 빈 행을 넣어 분리해야 한다.
즉 패키지 선언부, import 문 각 함수 사이에는 빈행이 들어가야 하는데 이는 새로운 개념이 생성된다는 뜻이다.

5. 수직거리

함수 연관 관계와 동작 방식을 이해하려고 이 함수에서 저 함수로 오가며 소스파일을 위아래로 뒤지는 등 뺑뺑이를 돌았으나 결국은 미로 같은 코드 때문에 혼란만 가중된 경험이 있을 것이다. 또한 함수나 변수가 정의된 코드를 찾으려 상속관계를 줄줄이 거슬러 올라간 경험도 있을 것이다. 이건 굉장히 달갑지 않은 경험이다. 시스템이 무엇을 하는 지 이해하고 싶은데 이 조각 저조각 찾고 기억하느라 시간과 노력을 소모한다.

그렇기 때문에 서로 밀접한 개념은 세로로 가까이 둬야 한다. 물론 두 개념이 서로 다른 파일에 속한다면 규칙이 통하지 않는다.
하지만 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 마땅하다. 이게 바로 protected 변수를 피해야 하는 이유중 하나이다. 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다.

(1) 변수선언 : 변수는 사용하는 위치에 최대한 가까이 선언한다. 루프를 제어하는 변수는 흔히 루프 문 내부에 선언한다.
(2) 인스턴스 변수: 인스턴스 변수는 클래스 맨 처음에 선언한다
(3) 종속함수: 한 함수가 다른 함수를호출 한다면 두 함수는 세로로 가까이 배치 한다. 또한 가능 하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다.
(참고) 상수를 알아야 마땅한 함수에서 실제로 사용하는 함수로 상수를 넘겨주는 방법이 더 좋다.

6. 개념적 유사성

어떤 코드는 서로 끌어당긴다. 개념적인 친화도가 높기 때문이다. 친화도가 높은 코드일 수록 가까이 배치한다.
친화도가 높은 요인은 다음과같다.

(1) 한 함수가 다른 함수를 호출 하는 경우
(2) 변수와 그 변수를 사용하는 함수
(3) 아래와 같이 명명법이 똑같고 기본 기능이 유사함. 또한 서로가 서로를 호출

public class Assert { static public void assertTrue(String message, boolean condition){ if (!condition) { fail(message); } } static public void assertTrue(boolean condition){ assertTrue(null, condition); } static public void assertFalse(String message, boolean condition){ assertTrue(message, !condition); } static public void assertFalse(boolean condition){ assertFalse(null, condition); } }

7. 세로순서

일반 적으로 함수 호출 종속성은 아래 방향으로 유지한다. 다시 말해 호출되는 함수는 호출하는 함수보다 나중에 위치한다. 또한 중요한 개념을 가장위에 작성하고 세부적인 내용은 마지막에 포함하자.

8. 가로 행의 길이

프로그래머는 명백하게 짧은 행을 선호한다. 그러므로 짧은 행이 바람직하다. 100자나 120자가 이상적이다.

9. 들여쓰기

때로 짧은 코드는 들여쓰기를 무시하는 경우가 있는데 되도록 들여쓰기를 하도록 하자.

String name; public String setName(String name){ this.name = name; } public String setName(String name){ this.name = name; } 

10. 팀규칙

프로그래머는 각자 선호 하는 규칙이 있지만 가장 선호해할 규칙을 팀규칙 이다.

---

즉 프로그래머는 특정 규칙을 정하고 그 규칙에 맞게 코드를 작성해야한다. 여기서 인상깊었던 점은 코드를 신문기사 처럼 작성하라는 것이었다. 가장 핵심적이고 고차원 적인 설명을 상단에 작성하고 아래로 내려갈 수록 세세한 내용을 기술 하라는 것이다. 또 친밀도가 밀접한 코드는 서로 가까이 작성해야한다.