[Clean Code] TIL - 220130

5장. 형식 맞추기

 

독자가 읽기 편하게 코드 형식을 맞추자!

 

1. 생각

코드도 책이나 기사와 같이 독자가 읽기 편하게 작성해야 한다.

내용에만 온전히 집중할 수 있게 불편한 요인을 최대한 줄여야 한다.

비슷하거나 서로 연관되는 부분들은 가까이에 붙여서 읽다가 물음표가 나오지 않도록 해야한다.

책에 문단을 띄우듯이 코드 내에 다른 개념들이 있다면 행을 적절히 띄워서 읽기 편하게 해야 한다.

큰 개요나 개념을 가장 위에 써서 전체적으로 어떤 것에 대한 내용인지 알 수 있게 해야 한다.

나중에 다른 사람이 작성된 코드를 수정할 수 있지만 이러한 형식이 없어지긴 힘들 것이다.

 

또한 전문가가 썼다는 인상이 들도록 질서 정연하게 작성하자.

일관적이며 꼼꼼하고 깔끔하면 질서 정연해 보인다.

 

2. 기억하고 싶은 내용들

프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다. 코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다.

 

코드 형식은 중요하다!

너무나도 중요하므로 융통성 없이 맹목적으로 따르면 안 된다.

코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다.

 

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

원래 코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.

 

- 적절한 행 길이를 유지하라

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

 

신문 기사처럼 작성하라

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

소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다.

 

개념은 빈 행으로 분리하라

일련의 행 묶음은 완결된 생각 하나를 표현한다. 생각 사이에 빈 행을 넣어 분리해야 마땅하다.

 

세로 밀집도

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

 

수직 거리

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

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

 

종속 함수

한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다. 규칙을 일관적으로 적용한다면 독자는 방금 호출한 함수가 잠시 후에 정의되리라는 사실을 예측한다.

 

개념적 유사성

친화도가 높을수록 코드를 가까이 배치한다.

비슷한 동작을 수행하는 일군의 함수가 좋은 예다.

 

세로 순서

일반적으로 함수 호출 종속석은 아래 방향으로 유지한다. 다시 말해, 호출되는 함수를 호출하는 함수보다 나중에 배치한다. 그러면 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.

신문 기사와 마찬가지로 가장 중요한 개념을 가장 먼저 표현한다.

그러면 독자가 소스 파일에서 첫 함수 몇 개만 읽어도 개념을 파악하기 쉬워진다.