[Book] 클린코드 - 5장 형식 맞추기

5장 형식 맞추기

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

코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다.
코드 형식은 의사소통의 일환이기 때문에 팀으로 일한다면 팀이 합의해 규칙을 정하고 모두가 그 규칙을 따라야 한다.

 

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

행 길이는 파일의 크기(길이)를 말한다.

500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다.

 

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

소스 파일의 이름은 간단하면서도 설명이 가능하게 짓는다.

이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다.

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

 

3. 개념은 빈 행으로 분리하라

거의 모든 코드는 왼쪽에서 오른쪽으로 위에서 아래로 읽힌다.

각 행은 수식이나 절을 나타내고 일련의 행 묶음은 완결된 생각 하나를 표현한다.

생각 사이는 빈 행을 넣어 분리해야 마땅하다. 그렇지 않으면 코드 가독성이 현저히 떨어진다.

 

4. 수직 거리

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

• 변수 선언: 사용하는 위치에 최대한 가까이 선언한다.
• 인스턴스 변수: 클래스 맨 처음에 선언하고 변수 간에 세로로 거리를 두지 않는다. (세로 밀집도)
• 종속 함수: 한 함수가 다른 함수를 호출한다면 두 함수를 세로로 가까이 배치한다. 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. (세로 순서)
• 개념적 유사성: 친화도가 높을수록 코드를 가까이 배치한다. Ex) 종속 함수, 변수와 그 변수를 사용하는 함수, 비슷한 동작을 수행하는 함수 등

 

5. 가로 형식 맞추기

오른쪽으로 스크롤할 필요가 절대로 없게 약 120자 정도로 행 길이를 제한한다.

 

6. 가로 정렬

선언문과 할당문을 별도로 정렬하지 않는다. 정렬하지 않으면 오히려 중대한 결함을 찾기 쉽다.

 

7. 가짜 범위

빈 while 문이나 for 문은 피하고 피하지 못할 때는 빈 블록을 올바로 들여 쓰고 괄호로 감싼다.