[Clean Code] 5. 형식 맞추기

이 글은 Clean code 책 내용을 정리한 글입니다.

저작권 관련 문제가 있다면 "meme91322367@gmail.com"으로 메일 보내주시면, 바로 삭제하도록 하겠습니다.

5장 형식 맞추기

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

형식을 맞추는 목적

• 융통성 없이 맹목적으로 따르면 안 된다.
• 코드 형식을 의사소통의 일환이다.
• 의사소통은 전문 개발자의 일차적인 의무이다.
• 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.
• 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.
• 원할한 소통을 장려하는 코드 형식

적절한 행 길이를 유지하라

• 500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다.
• 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.

신문 기사처럼 작성하라

• 이름은 간단하면서도 설명이 가능하게 짓는다.
• 이름만 보고도 올바른 모듈을 살펴보고 있는 지 아닌지를 판단할 정도로 신경 써서 짓는다.
• 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다.
• 아래로 내려갈수록 의도를 세세하게 묘사한다.
• 마지막에는 가장 저차원 함수와 세부 내역이 나온다.

개념은 빈 행으로 분리하라

• 생각 사이는 빈 행을 넣어 분리해야 마땅하다.
• 빈 행은 새로운 개념을 시작한다는 시작적 단서다.

세로 밀집도

• 줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다.
• 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다.
• 의미 없는 주석으로 두 인스턴스 변수를 떨어뜨려 놓지 말자.

수직 거리

• 이 함수에서 저 함수로 오가며 보는 미로같은 코드
• 시스템이 무엇을 하는 지 이해하고 싶은 데, 이 조각 저 조각이 어디에 있는 지 찾고 기억하는 라 시간과 노력을 소모한다.
• 서로 밀접한 개념은 세로로 가까이 둬야 한다.
• 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다.
• 두 개념이 서로 다른 파일에 속한다면 규칙이 통하지 않는 다. 하지만 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 마땅하다.
• 연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다.

변수 선언

• 변수는 사용하는 위치에 최대한 가까이 선언한다.
• 지역 변수는 각 함수 맨 처음에 선언한다.

인스턴스 변수

• 인스턴스 변수는 클래스 맨 처음에 선언한다.
• 잘 설계한 클래스는 많은 클래스 메서드가 인스턴스 변수를 사용하기 때문이다.

종속 함수

• 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
• 호출하는 함수를 호출되는 함수보다 먼저 배치한다.
• 규칙을 일관적으로 적용한다면 독자는 방금 호출한 함수가 잠시 후에 정의되리라는 사실을 예측한다.

개념적 유사성

• 친화도가 높을 수록 코드를 가까이 배치한다.
• 한 함수가 다른 함수를 호출하는 종속성, 변수와 그 변수를 사용하는 함수, 비슷한 동작을 수행하는 함수
• 종속적인 관계가 없더라도 가까이 배치할 함수

세로 순서

• 호출되는 함수를 호출하는 함수보다 나중에 배치한다.
• 가장 중요한 개념을 가장 먼저 표현한다.
• 중요한 개념을 표현할 떄는 세세한 사항을 최대한 배제한다.
• 세세한 사항은 가장 마지막에 표현한다.

가로 형식 맞추기

• 120자 정도로 행 길이를 제한한다.

가로 공백과 밀집도

• 공백을 넣으면 두 가지 주요 요소가 확실히 나뉜다는 사실이 더욱 분명해진다.
• 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않는다. 함수와 인수는 서로 밀접하기 때문이다.
• 함수를 호출하는 코드에서 괄호 안 인수는 공백으로 분리한다.
• 연산자 우선 순위를 강조하기 위해서도 공백을 사용한다.

가로 정렬

• 정렬이 필요할 정도로 목록이 길다면 문제는 목록 길이지 정렬 부족이 아니다.
• 선언부가 길다면 클래스를 쪼개야 한다는 의미다.

들여쓰기

• 범위로 이뤄진 계층을 표현하기 위해 우리는 코드를 들여쓴다.
• 들여쓰기한 파일은 구조가 한눈에 들어온다.

들여쓰기 무시하기

• 간단한 if, 짧은 while문, 짦은 함수에서 들여쓰기 규칙을 무시하고픈 유혹이 생긴다.
• 한 행에 범위를 뭉뚱그린 코드를 피한다.

가짜 범위

• 빈 while 문이나 for 문은 가능한 피한다.
• 세미콜론(;)은 새 행에다 제대로 들여써서 넣어준다.

팀 규칙

• 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.
• 스타일은 일관적이고 매끄러워야 한다.
• 한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이라는 신뢰감을 독자에게 줘야 한다.
• 온갖 스타일을 뒤섞어 소스 코드를 필요 이상으로 복잡하게 만드는 실수는 반드시 피한다.