Clean Code - 5장 형식 맞추기

 

1. 형식을 맞추는 목적

오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.

오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도

맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확정성에 계속 영향을 미친다.

 

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

 

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

독자는 표제를 보고서 기사를 읽을지 말지 결정한다.

쭉 읽으며 내려가면 세세한 사실이 조금씩 드러난다.

소스 파일도 신문 기사와 비슷하게 작성한다.

이름은 간단하면서도 설명이 가능하게 짓는다.

아래로 내려갈수록 의도를 세세하게 묘사한다.

 

4. 세로 밀집도

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

 

5. 수직 거리

함수 연관 관계와 동작 방식을 이해하려고 이 함수에서 저 함수로 오가며

소스 파일을 위아래로 뒤지는 등 뺑뺑이를 돌았으나 결국은 미로 같은 코드 때문에 혼란만 가중된 경험이 있는가?

 

서로 밀접한 개념은 세로로 가까이 둬야 한다.

 

연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다.

 

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

인스턴스 변수. 인스턴스 변수는 클래스 맨 처음에 선언한다.

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